Clients - accountinfo GET
Get client account information.
/clients/accountinfo
HTTP/1.1 200 OK "Client account information."
Get client account information.
/clients/accountinfo
HTTP/1.1 200 OK "Client account information."
Get client account information.
/clients/accountinfo
HTTP/1.1 200 OK "Client account information."
Get client account information.
/clients/accountinfo
HTTP/1.1 200 OK "Client account information."
Get client account information.
/clients/accountinfo
HTTP/1.1 200 OK "Client account information."
Update client account information.
/clients/accountinfo
https://api.idxbroker.com/clients/accountinfo
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = [
'displayName' => 'Test Display',
'address' => 'Test Street',
'city' => 'Test',
'stateProvince' => 'OR', // stateProvince needs to be in abbreviated form.
'zipCode' => '97402',
'phone1' => '5415555555',
'phone2' => '5415555555'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200/204 OK "204 response code."
Update client account information.
/clients/accountinfo
https://api.idxbroker.com/clients/accountinfo
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = [
'displayName' => 'Test Display',
'address' => 'Test Street',
'city' => 'Test',
'stateProvince' => 'OR', // stateProvince needs to be in abbreviated form.
'zipCode' => '97402',
'phone1' => '5415555555',
'phone2' => '5415555555'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200/204 OK "204 response code."
Update client account information.
/clients/accountinfo
https://api.idxbroker.com/clients/accountinfo
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = [
'displayName' => 'Test Display',
'address' => 'Test Street',
'city' => 'Test',
'stateProvince' => 'OR', // stateProvince needs to be in abbreviated form.
'zipCode' => '97402',
'phone1' => '5415555555',
'phone2' => '5415555555'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200/204 OK "204 response code."
Update client account information.
/clients/accountinfo
https://api.idxbroker.com/clients/accountinfo
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = [
'displayName' => 'Test Display',
'address' => 'Test Street',
'city' => 'Test',
'stateProvince' => 'OR', // stateProvince needs to be in abbreviated form.
'zipCode' => '97402',
'phone1' => '5415555555',
'phone2' => '5415555555'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200/204 OK "204 response code."
Get your account type.
/clients/accounttype
HTTP/1.1 200 OK "account type":
Get your account type.
/clients/accounttype
HTTP/1.1 200 OK "account type":
Get your account type.
/clients/accounttype
HTTP/1.1 200 OK "account type":
Get your account type.
/clients/accounttype
HTTP/1.1 200 OK "account type":
Get your account type.
/clients/accounttype
HTTP/1.1 200 OK "account type":
Get your account type.
/clients/accounttype
HTTP/1.1 200 OK "account type":
Get your account type.
/clients/accounttype
HTTP/1.1 200 OK "account type":
Get your account type.
/clients/accounttype
HTTP/1.1 200 OK "account type":
Get your account type.
/clients/accounttype
HTTP/1.1 200 OK "account type":
Get your account type.
/clients/accounttype
HTTP/1.1 200 OK "account type":
Get your account type.
/clients/accounttype
HTTP/1.1 200 OK "account type":
Get your account type.
/clients/accounttype
HTTP/1.1 200 OK "account type":
View agent information on a multi-user account.
/clients/agents
https://api.idxbroker.com/clients/agents?filterField=agentID&filterValue=1&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | string |
There are several dates associated with an agent, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All agents on the account or those matching filter values."
View agent information on a multi-user account.
/clients/agents
https://api.idxbroker.com/clients/agents?filterField=agentID&filterValue=1&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | string |
There are several dates associated with an agent, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All agents on the account or those matching filter values."
View agent information on a multi-user account.
/clients/agents
https://api.idxbroker.com/clients/agents?filterField=agentID&filterValue=1&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | string |
There are several dates associated with an agent, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All agents on the account or those matching filter values."
View agent information on a multi-user account.
/clients/agents
https://api.idxbroker.com/clients/agents?filterField=agentID&filterValue=1&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | string |
There are several dates associated with an agent, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All agents on the account or those matching filter values."
View agent information on a multi-user account.
/clients/agents
https://api.idxbroker.com/clients/agents?filterField=agentID&filterValue=1&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | string |
There are several dates associated with an agent, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All agents on the account or those matching filter values."
View agent information on a multi-user account.
/clients/agents
https://api.idxbroker.com/clients/agents?filterField=agentID&filterValue=1&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | string |
There are several dates associated with an agent, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All agents on the account or those matching filter values."
View agent information on a multi-user account.
/clients/agents
https://api.idxbroker.com/clients/agents?filterField=agentID&filterValue=1&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | string |
There are several dates associated with an agent, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All agents on the account or those matching filter values."
View agent information on a multi-user account.
/clients/agents
https://api.idxbroker.com/clients/agents?filterField=agentID&filterValue=1&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | string |
There are several dates associated with an agent, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All agents on the account or those matching filter values."
View agent information on a multi-user account.
/clients/agents
https://api.idxbroker.com/clients/agents?filterField=agentID&filterValue=1&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | string |
There are several dates associated with an agent, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All agents on the account or those matching filter values."
View agent information on a multi-user account.
/clients/agents
https://api.idxbroker.com/clients/agents?filterField=agentID&filterValue=1&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | string |
There are several dates associated with an agent, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All agents on the account or those matching filter values."
View agent information on a multi-user account.
/clients/agents
https://api.idxbroker.com/clients/agents?filterField=agentID&filterValue=1&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | string |
There are several dates associated with an agent, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All agents on the account or those matching filter values."
View agent information on a multi-user account.
/clients/agents
https://api.idxbroker.com/clients/agents?filterField=agentID&filterValue=1
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
HTTP/1.1 200 OK "All agents on the account or those matching filter values."
Get the default api version.
/clients/apiversion
HTTP/1.1 200 OK "The default api version."
Get the default api version.
/clients/apiversion
HTTP/1.1 200 OK "The default api version."
Get the default api version.
/clients/apiversion
HTTP/1.1 200 OK "The default api version."
Get the default api version.
/clients/apiversion
HTTP/1.1 200 OK "The default api version."
Get the default api version.
/clients/apiversion
HTTP/1.1 200 OK "The default api version."
Get the default api version.
/clients/apiversion
HTTP/1.1 200 OK "The default api version."
Get the default api version.
/clients/apiversion
HTTP/1.1 200 OK "The default api version."
Get the default api version.
/clients/apiversion
HTTP/1.1 200 OK "The default api version."
Returns the cities available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS
/clients/cities
https://api.idxbroker.com/clients/cities/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All cities in a given list or, if no list ID is provided, a list of list IDs."
Returns the cities available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS
/clients/cities
https://api.idxbroker.com/clients/cities/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All cities in a given list or, if no list ID is provided, a list of list IDs."
Returns the cities available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS
/clients/cities
https://api.idxbroker.com/clients/cities/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All cities in a given list or, if no list ID is provided, a list of list IDs."
Returns the cities available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS
/clients/cities
https://api.idxbroker.com/clients/cities/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All cities in a given list or, if no list ID is provided, a list of list IDs."
Returns the cities available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS
/clients/cities
https://api.idxbroker.com/clients/cities/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All cities in a given list or, if no list ID is provided, a list of list IDs."
Returns the cities available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS
/clients/cities
https://api.idxbroker.com/clients/cities/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All cities in a given list or, if no list ID is provided, a list of list IDs."
Returns the cities available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS
/clients/cities
https://api.idxbroker.com/clients/cities/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All cities in a given list or, if no list ID is provided, a list of list IDs."
Returns the cities available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS
/clients/cities
https://api.idxbroker.com/clients/cities/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All cities in a given list or, if no list ID is provided, a list of list IDs."
Returns the cities available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS
/clients/cities
https://api.idxbroker.com/clients/cities/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All cities in a given list or, if no list ID is provided, a list of list IDs."
Returns the cities available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS
/clients/cities
https://api.idxbroker.com/clients/cities/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All cities in a given list or, if no list ID is provided, a list of list IDs."
Returns the cities available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS
/clients/cities
https://api.idxbroker.com/clients/cities/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All cities in a given list or, if no list ID is provided, a list of list IDs."
Returns the cities available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS
/clients/cities
https://api.idxbroker.com/clients/cities/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
HTTP/1.1 200 OK "All cities in a given list or, if no list ID is provided, a list of list IDs."
Returns the cities (limited to sold data) available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID.
/clients/cities/sold
https://api.idxbroker.com/clients/cities/sold/123
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All cities in a given list or, if no list ID is provided, a list of list IDs."
Returns the cities (limited to sold data) available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID.
/clients/cities/sold
https://api.idxbroker.com/clients/cities/sold/123
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All cities in a given list or, if no list ID is provided, a list of list IDs."
Returns the cities (limited to sold data) available in each of a client's city lists. Since a client can build any number of city lists this method requires the ID of which list you want to view. To get a list of all city lists available do not send the primary request ID.
/clients/cities/sold
https://api.idxbroker.com/clients/cities/sold/123
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All cities in a given list or, if no list ID is provided, a list of list IDs."
Returns the IDs and names for each of a client's city lists including MLS city lists. To get the list of all city lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
Note: This method was previously camelcased as "citiesListName" but was made lower case to fit the API naming convention. Calls to "citiesListName" will be forwarded to "citieslistname" and "citiesListName" is listed as deprecated in the method list.
/clients/citieslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's city lists including MLS city lists. To get the list of all city lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
Note: This method was previously camelcased as "citiesListName" but was made lower case to fit the API naming convention. Calls to "citiesListName" will be forwarded to "citieslistname" and "citiesListName" is listed as deprecated in the method list.
/clients/citieslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's city lists including MLS city lists. To get the list of all city lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
Note: This method was previously camelcased as "citiesListName" but was made lower case to fit the API naming convention. Calls to "citiesListName" will be forwarded to "citieslistname" and "citiesListName" is listed as deprecated in the method list.
/clients/citieslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's city lists including MLS city lists. To get the list of all city lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
Note: This method was previously camelcased as "citiesListName" but was made lower case to fit the API naming convention. Calls to "citiesListName" will be forwarded to "citieslistname" and "citiesListName" is listed as deprecated in the method list.
/clients/citieslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's city lists including MLS city lists. To get the list of all city lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
Note: This method was previously camelcased as "citiesListName" but was made lower case to fit the API naming convention. Calls to "citiesListName" will be forwarded to "citieslistname" and "citiesListName" is listed as deprecated in the method list.
/clients/citieslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's city lists including MLS city lists. To get the list of all city lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
Note: This method was previously camelcased as "citiesListName" but was made lower case to fit the API naming convention. Calls to "citiesListName" will be forwarded to "citieslistname" and "citiesListName" is listed as deprecated in the method list.
/clients/citieslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's city lists including MLS city lists. To get the list of all city lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
Note: This method was previously camelcased as "citiesListName" but was made lower case to fit the API naming convention. Calls to "citiesListName" will be forwarded to "citieslistname" and "citiesListName" is listed as deprecated in the method list.
/clients/citieslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's city lists including MLS city lists. To get the list of all city lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
Note: This method was previously camelcased as "citiesListName" but was made lower case to fit the API naming convention. Calls to "citiesListName" will be forwarded to "citieslistname" and "citiesListName" is listed as deprecated in the method list.
/clients/citieslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's city lists including MLS city lists. To get the list of all city lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
Note: This method was previously camelcased as "citiesListName" but was made lower case to fit the API naming convention. Calls to "citiesListName" will be forwarded to "citieslistname" and "citiesListName" is listed as deprecated in the method list.
/clients/citieslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's city lists including MLS city lists. To get the list of all city lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
Note: This method was previously camelcased as "citiesListName" but was made lower case to fit the API naming convention. Calls to "citiesListName" will be forwarded to "citieslistname" and "citiesListName" is listed as deprecated in the method list.
/clients/citieslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's city lists including MLS city lists. To get the list of all city lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
Note: This method was previously camelcased as "citiesListName" but was made lower case to fit the API naming convention. Calls to "citiesListName" will be forwarded to "citieslistname" and "citiesListName" is listed as deprecated in the method list.
/clients/citieslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's city lists including MLS city lists. To get the list of all city lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
Note: This method was previously camelcased as "citiesListName" but was made lower case to fit the API naming convention. Calls to "citiesListName" will be forwarded to "citieslistname" and "citiesListName" is listed as deprecated in the method list.
/clients/citieslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the counties available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
/clients/counties
https://api.idxbroker.com/clients/counties/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All counties in a given list or, if no list ID is provided, a list of list IDs."
Returns the counties available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
/clients/counties
https://api.idxbroker.com/clients/counties/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All counties in a given list or, if no list ID is provided, a list of list IDs."
Returns the counties available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
/clients/counties
https://api.idxbroker.com/clients/counties/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All counties in a given list or, if no list ID is provided, a list of list IDs."
Returns the counties available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
/clients/counties
https://api.idxbroker.com/clients/counties/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All counties in a given list or, if no list ID is provided, a list of list IDs."
Returns the counties available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
/clients/counties
https://api.idxbroker.com/clients/counties/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All counties in a given list or, if no list ID is provided, a list of list IDs."
Returns the counties available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
/clients/counties
https://api.idxbroker.com/clients/counties/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All counties in a given list or, if no list ID is provided, a list of list IDs."
Returns the counties available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
/clients/counties
https://api.idxbroker.com/clients/counties/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All counties in a given list or, if no list ID is provided, a list of list IDs."
Returns the counties available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
/clients/counties
https://api.idxbroker.com/clients/counties/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All counties in a given list or, if no list ID is provided, a list of list IDs."
Returns the counties available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
/clients/counties
https://api.idxbroker.com/clients/counties/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All counties in a given list or, if no list ID is provided, a list of list IDs."
Returns the counties available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
/clients/counties
https://api.idxbroker.com/clients/counties/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All counties in a given list or, if no list ID is provided, a list of list IDs."
Returns the counties available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
/clients/counties
https://api.idxbroker.com/clients/counties/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All counties in a given list or, if no list ID is provided, a list of list IDs."
Returns the counties available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
/clients/counties
https://api.idxbroker.com/clients/counties/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
HTTP/1.1 200 OK "All counties in a given list or, if no list ID is provided, a list of list IDs."
Returns the counties (limited to sold data) available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID.
/clients/counties/sold
https://api.idxbroker.com/clients/counties/sold/123
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All counties in a given list or, if no list ID is provided, a list of list IDs."
Returns the counties (limited to sold data) available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID.
/clients/counties/sold
https://api.idxbroker.com/clients/counties/sold/123
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All counties in a given list or, if no list ID is provided, a list of list IDs."
Returns the counties (limited to sold data) available in each of a client's county lists. Since a client can build any number of county lists this method requires the ID of which list you want to view. To get a list of all county lists available do not send the primary request ID.
/clients/counties/sold
https://api.idxbroker.com/clients/counties/sold/123
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All counties in a given list or, if no list ID is provided, a list of list IDs."
Returns the IDs and names for each of a client's counties lists including MLS counties lists. To get the list of all counties lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/countieslistname
HTTP/1.1 200 OK "A list of counties list IDs and names"
Returns the IDs and names for each of a client's counties lists including MLS counties lists. To get the list of all counties lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/countieslistname
HTTP/1.1 200 OK "A list of counties list IDs and names"
Returns the IDs and names for each of a client's counties lists including MLS counties lists. To get the list of all counties lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/countieslistname
HTTP/1.1 200 OK "A list of counties list IDs and names"
Returns the IDs and names for each of a client's counties lists including MLS counties lists. To get the list of all counties lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/countieslistname
HTTP/1.1 200 OK "A list of counties list IDs and names"
Returns the IDs and names for each of a client's counties lists including MLS counties lists. To get the list of all counties lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/countieslistname
HTTP/1.1 200 OK "A list of counties list IDs and names"
Returns the IDs and names for each of a client's counties lists including MLS counties lists. To get the list of all counties lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/countieslistname
HTTP/1.1 200 OK "A list of counties list IDs and names"
Returns the IDs and names for each of a client's counties lists including MLS counties lists. To get the list of all counties lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/countieslistname
HTTP/1.1 200 OK "A list of counties list IDs and names"
Returns the IDs and names for each of a client's counties lists including MLS counties lists. To get the list of all counties lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/countieslistname
HTTP/1.1 200 OK "A list of counties list IDs and names"
Update dynamic wrapper url for global, pages and saved links. If savedLinkID, or pageID are not passed, the global dynamic wrapper url will be updated.
/clients/dynamicwrapperurl
http://api.idxbroker.com/clients/dynamicwrapperurl
// Note: The fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'pageID' => '123',
'dynamicURL' => 'http://example.com'
);
| Field | Type | Description |
|---|---|---|
| dynamicURL | string |
dynamic wrapper url. |
| savedLinkID optional | number |
saved link ID if setting dynamic wrapper url for a specific saved link. |
| pageID optional | number |
page ID if setting dynamic wrapper url for a specific page. |
HTTP/1.1 204 OK
HTTP/1.1 400 "Invalid savedLinkID or pageID will result in 400 error".
HTTP/1.1 400 "dynamicURL is required."
Update dynamic wrapper url for global, pages and saved links. If savedLinkID, or pageID are not passed, the global dynamic wrapper url will be updated.
/clients/dynamicwrapperurl
http://api.idxbroker.com/clients/dynamicwrapperurl
// Note: The fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'pageID' => '123',
'dynamicURL' => 'http://example.com'
);
| Field | Type | Description |
|---|---|---|
| dynamicURL | string |
dynamic wrapper url. |
| savedLinkID optional | number |
saved link ID if setting dynamic wrapper url for a specific saved link. |
| pageID optional | number |
page ID if setting dynamic wrapper url for a specific page. |
HTTP/1.1 204 OK
HTTP/1.1 400 "Invalid savedLinkID or pageID will result in 400 error".
HTTP/1.1 400 "dynamicURL is required."
Update dynamic wrapper url for global, pages and saved links. If savedLinkID, or pageID are not passed, the global dynamic wrapper url will be updated.
/clients/dynamicwrapperurl
http://api.idxbroker.com/clients/dynamicwrapperurl
// Note: The fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'pageID' => '123',
'dynamicURL' => 'http://example.com'
);
| Field | Type | Description |
|---|---|---|
| dynamicURL | string |
dynamic wrapper url. |
| savedLinkID optional | number |
saved link ID if setting dynamic wrapper url for a specific saved link. |
| pageID optional | number |
page ID if setting dynamic wrapper url for a specific page. |
HTTP/1.1 204 OK
HTTP/1.1 400 "Invalid savedLinkID or pageID will result in 400 error".
HTTP/1.1 400 "dynamicURL is required."
Update dynamic wrapper url for global, pages and saved links. If savedLinkID, or pageID are not passed, the global dynamic wrapper url will be updated.
/clients/dynamicwrapperurl
http://api.idxbroker.com/clients/dynamicwrapperurl
// Note: The fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'pageID' => '123',
'dynamicURL' => 'http://example.com'
);
| Field | Type | Description |
|---|---|---|
| dynamicURL | string |
dynamic wrapper url. |
| savedLinkID optional | number |
saved link ID if setting dynamic wrapper url for a specific saved link. |
| pageID optional | number |
page ID if setting dynamic wrapper url for a specific page. |
HTTP/1.1 204 OK
HTTP/1.1 400 "Invalid savedLinkID or pageID will result in 400 error".
HTTP/1.1 400 "dynamicURL is required."
Update dynamic wrapper url for global, pages and saved links. If savedLinkID, or pageID are not passed, the global dynamic wrapper url will be updated.
/clients/dynamicwrapperurl
http://api.idxbroker.com/clients/dynamicwrapperurl
// Note: The fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'pageID' => '123',
'dynamicURL' => 'http://example.com'
);
| Field | Type | Description |
|---|---|---|
| dynamicURL | string |
dynamic wrapper url. |
| savedLinkID optional | number |
saved link ID if setting dynamic wrapper url for a specific saved link. |
| pageID optional | number |
page ID if setting dynamic wrapper url for a specific page. |
HTTP/1.1 204 OK
HTTP/1.1 400 "Invalid savedLinkID or pageID will result in 400 error".
HTTP/1.1 400 "dynamicURL is required."
Update dynamic wrapper url for global, pages and saved links. If savedLinkID, or pageID are not passed, the global dynamic wrapper url will be updated.
/clients/dynamicwrapperurl
http://api.idxbroker.com/clients/dynamicwrapperurl
// Note: The fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'pageID' => '123',
'dynamicURL' => 'http://example.com'
);
| Field | Type | Description |
|---|---|---|
| dynamicURL | string |
dynamic wrapper url. |
| savedLinkID optional | number |
saved link ID if setting dynamic wrapper url for a specific saved link. |
| pageID optional | number |
page ID if setting dynamic wrapper url for a specific page. |
HTTP/1.1 204 OK
HTTP/1.1 400 "Invalid savedLinkID or pageID will result in 400 error".
HTTP/1.1 400 "dynamicURL is required."
Update dynamic wrapper url for global, pages and saved links. If savedLinkID, or pageID are not passed, the global dynamic wrapper url will be updated.
/clients/dynamicwrapperurl
http://api.idxbroker.com/clients/dynamicwrapperurl
// Note: The fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'pageID' => '123',
'dynamicURL' => 'http://example.com'
);
| Field | Type | Description |
|---|---|---|
| dynamicURL | string |
dynamic wrapper url. |
| savedLinkID optional | number |
saved link ID if setting dynamic wrapper url for a specific saved link. |
| pageID optional | number |
page ID if setting dynamic wrapper url for a specific page. |
HTTP/1.1 204 OK
HTTP/1.1 400 "Invalid savedLinkID or pageID will result in 400 error".
HTTP/1.1 400 "dynamicURL is required."
Update dynamic wrapper url for global, pages and saved links. If savedLinkID, or pageID are not passed, the global dynamic wrapper url will be updated.
/clients/dynamicwrapperurl
http://api.idxbroker.com/clients/dynamicwrapperurl
// Note: The fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'pageID' => '123',
'dynamicURL' => 'http://example.com'
);
| Field | Type | Description |
|---|---|---|
| dynamicURL | string |
dynamic wrapper url. |
| savedLinkID optional | number |
saved link ID if setting dynamic wrapper url for a specific saved link. |
| pageID optional | number |
page ID if setting dynamic wrapper url for a specific page. |
HTTP/1.1 204 OK
HTTP/1.1 400 "Invalid savedLinkID or pageID will result in 400 error".
HTTP/1.1 400 "dynamicURL is required."
Update dynamic wrapper url for global, pages and saved links. If savedLinkID, or pageID are not passed, the global dynamic wrapper url will be updated.
/clients/dynamicwrapperurl
http://api.idxbroker.com/clients/dynamicwrapperurl
// Note: The fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'pageID' => '123',
'dynamicURL' => 'http://example.com'
);
| Field | Type | Description |
|---|---|---|
| dynamicURL | string |
dynamic wrapper url. |
| savedLinkID optional | number |
saved link ID if setting dynamic wrapper url for a specific saved link. |
| pageID optional | number |
page ID if setting dynamic wrapper url for a specific page. |
HTTP/1.1 204 OK
HTTP/1.1 400 "Invalid savedLinkID or pageID will result in 400 error".
HTTP/1.1 400 "dynamicURL is required."
Update dynamic wrapper url for global, pages and saved links. If savedLinkID, or pageID are not passed, the global dynamic wrapper url will be updated.
/clients/dynamicwrapperurl
http://api.idxbroker.com/clients/dynamicwrapperurl
// Note: The fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'pageID' => '123',
'dynamicURL' => 'http://example.com',
);
| Field | Type | Description |
|---|---|---|
| dynamicURL | string |
dynamic wrapper url. |
| savedLinkID optional | number |
saved link ID if setting dynamic wrapper url for a specific saved link. |
| pageID optional | number |
page ID if setting dynamic wrapper url for a specific page. |
HTTP/1.1 204 OK
HTTP/1.1 400 "Invalid savedLinkID or pageID will result in 400 error".
HTTP/1.1 400 "dynamicURL is required."
Returns all the information for the client's featured (active) properties
/clients/featured
https://api.idxbroker.com/clients/featured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "Featured properties on the account."
Returns all the information for the client's featured (active) properties
/clients/featured
https://api.idxbroker.com/clients/featured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "Featured properties on the account."
Returns a basic set of information for all of the client's featured (active) properties
/clients/featured
https://api.idxbroker.com/clients/featured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "Featured properties on the account."
Returns a basic set of information for all of the client's featured (active) properties
/clients/featured
https://api.idxbroker.com/clients/featured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "Featured properties on the account."
Returns a basic set of information for all of the client's featured (active) properties
/clients/featured
https://api.idxbroker.com/clients/featured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "Featured properties on the account."
Returns a basic set of information for all of the client's featured (active) properties
/clients/featured
https://api.idxbroker.com/clients/featured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "Featured properties on the account."
Returns a basic set of information for all of the client's featured (active) properties
/clients/featured
https://api.idxbroker.com/clients/featured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "Featured properties on the account."
Returns a basic set of information for all of the client's featured (active) properties
/clients/featured
https://api.idxbroker.com/clients/featured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "Featured properties on the account."
Returns a basic set of information for all of the client's featured (active) properties
/clients/featured
https://api.idxbroker.com/clients/featured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "Featured properties on the account."
Returns a basic set of information for all of the client's featured (active) properties
/clients/featured
https://api.idxbroker.com/clients/featured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "Featured properties on the account."
Returns a basic set of information for all of the client's featured (active) properties
/clients/featured
https://api.idxbroker.com/clients/featured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "Featured properties on the account."
Returns a basic set of information for all of the client's featured (active) properties
/clients/featured
https://api.idxbroker.com/clients/featured
| Field | Type | Description |
|---|---|---|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "Featured properties on the account."
This is a simple, access anywhere, method for getting a list of all API components available.
/clients/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/clients/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/clients/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/clients/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/clients/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/clients/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/clients/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/clients/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/clients/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/clients/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/clients/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/clients/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/clients/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/clients/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/clients/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/clients/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/clients/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/clients/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/clients/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/clients/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/clients/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/clients/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/clients/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/clients/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
View all offices on a mutli-user account.
/clients/offices
https://api.idxbroker.com/clients/offices?filterField=officeID&filterValue=123&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | datetime |
There are several dates associated with an office, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All offices on the account or those matching filter values."
View all offices on a mutli-user account.
/clients/offices
https://api.idxbroker.com/clients/offices?filterField=officeID&filterValue=123&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | datetime |
There are several dates associated with an office, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All offices on the account or those matching filter values."
View all offices on a mutli-user account.
/clients/offices
https://api.idxbroker.com/clients/offices?filterField=officeID&filterValue=123&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | datetime |
There are several dates associated with an office, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All offices on the account or those matching filter values."
View all offices on a mutli-user account.
/clients/offices
https://api.idxbroker.com/clients/offices?filterField=officeID&filterValue=123&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | datetime |
There are several dates associated with an office, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All offices on the account or those matching filter values."
View all offices on a mutli-user account.
/clients/offices
https://api.idxbroker.com/clients/offices?filterField=officeID&filterValue=123&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | datetime |
There are several dates associated with an office, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All offices on the account or those matching filter values."
View all offices on a mutli-user account.
/clients/offices
https://api.idxbroker.com/clients/offices?filterField=officeID&filterValue=123&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | datetime |
There are several dates associated with an office, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All offices on the account or those matching filter values."
View all offices on a mutli-user account.
/clients/offices
https://api.idxbroker.com/clients/offices?filterField=officeID&filterValue=123&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | datetime |
There are several dates associated with an office, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All offices on the account or those matching filter values."
View all offices on a mutli-user account.
/clients/offices
https://api.idxbroker.com/clients/offices?filterField=officeID&filterValue=123&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | datetime |
There are several dates associated with an office, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All offices on the account or those matching filter values."
View all offices on a mutli-user account.
/clients/offices
https://api.idxbroker.com/clients/offices?filterField=officeID&filterValue=123&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | datetime |
There are several dates associated with an office, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All offices on the account or those matching filter values."
View all offices on a mutli-user account.
/clients/offices
https://api.idxbroker.com/clients/offices?filterField=officeID&filterValue=123&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | datetime |
There are several dates associated with an office, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All offices on the account or those matching filter values."
View all offices on a mutli-user account.
/clients/offices
https://api.idxbroker.com/clients/offices?filterField=officeID&filterValue=123&interval=24&startDatetime=2015-01-01+23:59:59&dateType=accountCreated
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| dateType optional | datetime |
There are several dates associated with an office, this will specify what is being used to return information. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All offices on the account or those matching filter values."
View all offices on a mutli-user account.
/clients/offices
https://api.idxbroker.com/clients/offices?filterField=officeID&filterValue=123
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
HTTP/1.1 200 OK "All offices on the account or those matching filter values."
Returns all the information for the client's off market properties
/clients/offmarket
https://api.idxbroker.com/clients/offmarket?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "Off market properties on the account."
Returns the postalcodes available in each of a client's postalcode lists. Since a client can build any number of postalcode lists this method requires the ID of which list you want to view. To get a list of all postalcode lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS. Note: This method was previously called as "zipcodes" but was changed to keep API format more international. Calls to "zipcodes" will be forwarded to "postalcodes" and "zipcodes" is listed as deprecated in the method list.
/clients/postalcodes
https://api.idxbroker.com/clients/postalcodes/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All postalcodes in a given list or, if no list ID is provided, a list of list IDs."
Returns the postalcodes available in each of a client's postalcode lists. Since a client can build any number of postalcode lists this method requires the ID of which list you want to view. To get a list of all postalcode lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS. Note: This method was previously called as "zipcodes" but was changed to keep API format more international. Calls to "zipcodes" will be forwarded to "postalcodes" and "zipcodes" is listed as deprecated in the method list.
/clients/postalcodes
https://api.idxbroker.com/clients/postalcodes/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All postalcodes in a given list or, if no list ID is provided, a list of list IDs."
Returns the postalcodes available in each of a client's postalcode lists. Since a client can build any number of postalcode lists this method requires the ID of which list you want to view. To get a list of all postalcode lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS. Note: This method was previously called as "zipcodes" but was changed to keep API format more international. Calls to "zipcodes" will be forwarded to "postalcodes" and "zipcodes" is listed as deprecated in the method list.
/clients/postalcodes
https://api.idxbroker.com/clients/postalcodes/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All postalcodes in a given list or, if no list ID is provided, a list of list IDs."
Returns the postalcodes available in each of a client's postalcode lists. Since a client can build any number of postalcode lists this method requires the ID of which list you want to view. To get a list of all postalcode lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS. Note: This method was previously called as "zipcodes" but was changed to keep API format more international. Calls to "zipcodes" will be forwarded to "postalcodes" and "zipcodes" is listed as deprecated in the method list.
/clients/postalcodes
https://api.idxbroker.com/clients/postalcodes/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All postalcodes in a given list or, if no list ID is provided, a list of list IDs."
Returns the postalcodes available in each of a client's postalcode lists. Since a client can build any number of postalcode lists this method requires the ID of which list you want to view. To get a list of all postalcode lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS. Note: This method was previously called as "zipcodes" but was changed to keep API format more international. Calls to "zipcodes" will be forwarded to "postalcodes" and "zipcodes" is listed as deprecated in the method list.
/clients/postalcodes
https://api.idxbroker.com/clients/postalcodes/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All postalcodes in a given list or, if no list ID is provided, a list of list IDs."
Returns the postalcodes available in each of a client's postalcode lists. Since a client can build any number of postalcode lists this method requires the ID of which list you want to view. To get a list of all postalcode lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS. Note: This method was previously called as "zipcodes" but was changed to keep API format more international. Calls to "zipcodes" will be forwarded to "postalcodes" and "zipcodes" is listed as deprecated in the method list.
/clients/postalcodes
https://api.idxbroker.com/clients/postalcodes/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All postalcodes in a given list or, if no list ID is provided, a list of list IDs."
Returns the postalcodes available in each of a client's postalcode lists. Since a client can build any number of postalcode lists this method requires the ID of which list you want to view. To get a list of all postalcode lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS. Note: This method was previously called as "zipcodes" but was changed to keep API format more international. Calls to "zipcodes" will be forwarded to "postalcodes" and "zipcodes" is listed as deprecated in the method list.
/clients/postalcodes
https://api.idxbroker.com/clients/postalcodes/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All postalcodes in a given list or, if no list ID is provided, a list of list IDs."
Returns the postalcodes available in each of a client's postalcode lists. Since a client can build any number of postalcode lists this method requires the ID of which list you want to view. To get a list of all postalcode lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS. Note: This method was previously called as "zipcodes" but was changed to keep API format more international. Calls to "zipcodes" will be forwarded to "postalcodes" and "zipcodes" is listed as deprecated in the method list.
/clients/postalcodes
https://api.idxbroker.com/clients/postalcodes/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All postalcodes in a given list or, if no list ID is provided, a list of list IDs."
Returns the postalcodes (limited to sold data) available in each of a client's postalcode lists. Since a client can build any number of postalcode lists this method requires the ID of which list you want to view. To get a list of all postalcode lists available do not send the primary request ID. Note: This method was previously called as "zipcodes" but was changed to keep API format more international. Calls to "zipcodes" will be forwarded to "postalcodes" and "zipcodes" is listed as deprecated in the method list.
/clients/postalcodes/sold
https://api.idxbroker.com/clients/postalcodes/sold/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All postalcodes in a given list or, if no list ID is provided, a list of list IDs."
Returns the postalcodes (limited to sold data) available in each of a client's postalcode lists. Since a client can build any number of postalcode lists this method requires the ID of which list you want to view. To get a list of all postalcode lists available do not send the primary request ID. Note: This method was previously called as "zipcodes" but was changed to keep API format more international. Calls to "zipcodes" will be forwarded to "postalcodes" and "zipcodes" is listed as deprecated in the method list.
/clients/postalcodes/sold
https://api.idxbroker.com/clients/postalcodes/sold/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All postalcodes in a given list or, if no list ID is provided, a list of list IDs."
Returns the postalcodes (limited to sold data) available in each of a client's postalcode lists. Since a client can build any number of postalcode lists this method requires the ID of which list you want to view. To get a list of all postalcode lists available do not send the primary request ID. Note: This method was previously called as "zipcodes" but was changed to keep API format more international. Calls to "zipcodes" will be forwarded to "postalcodes" and "zipcodes" is listed as deprecated in the method list.
/clients/postalcodes/sold
https://api.idxbroker.com/clients/postalcodes/sold/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All postalcodes in a given list or, if no list ID is provided, a list of list IDs."
Returns the IDs and names for each of a client's postalcode lists including MLS postalcode lists. To get the list of all postal code lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/postalcodeslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's postalcode lists including MLS postalcode lists. To get the list of all postal code lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/postalcodeslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's postalcode lists including MLS postalcode lists. To get the list of all postal code lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/postalcodeslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's postalcode lists including MLS postalcode lists. To get the list of all postal code lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/postalcodeslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's postalcode lists including MLS postalcode lists. To get the list of all postal code lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/postalcodeslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's postalcode lists including MLS postalcode lists. To get the list of all postal code lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/postalcodeslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's postalcode lists including MLS postalcode lists. To get the list of all postal code lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/postalcodeslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Returns the IDs and names for each of a client's postalcode lists including MLS postalcode lists. To get the list of all postal code lists available do not send the primary request ID. The default list on each account has the ID combinedActiveMLS
/clients/postalcodeslistname
HTTP/1.1 200 OK "A list of city list IDs and names"
Remove a new client saved link.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 204 OK
Remove a new client saved link.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 204 OK
Remove a new client saved link.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 204 OK
Remove a new client saved link.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 204 OK
Remove a new client saved link.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 204 OK
Remove a new client saved link.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 204 OK
Remove a new client saved link.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 204 OK
Remove a new client saved link.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 204 OK
Remove a new client saved link.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 204 OK
Remove a new client saved link.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 204 OK
Remove a new client saved link.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 204 OK
Get saved links for a given client account.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All saved links on the account."
Get saved links for a given client account.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All saved links on the account."
Get saved links for a given client account.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All saved links on the account."
Get saved links for a given client account.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All saved links on the account."
Get saved links for a given client account.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All saved links on the account."
Get saved links for a given client account.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All saved links on the account."
Get saved links for a given client account.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All saved links on the account."
Get saved links for a given client account.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All saved links on the account."
Get saved links for a given client account.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All saved links on the account."
Get saved links for a given client account.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All saved links on the account."
Get saved links for a given client account.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All saved links on the account."
Get saved links for a given client account.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks
HTTP/1.1 200 OK "All saved links on the account."
Update an existing client's saved link
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in broken saved links.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 200/204 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing client's saved link
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in broken saved links.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 200/204 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing client's saved link
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in broken saved links.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 200/204 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing client's saved link
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in broken saved links.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 200/204 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing client's saved link
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in broken saved links.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 200/204 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing client's saved link
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in broken saved links.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 200/204 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing client's saved link
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in broken saved links.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 200/204 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing client's saved link
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in broken saved links.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 200/204 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing client's saved link
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in broken saved links.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 200/204 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing client's saved link
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in broken saved links.
/clients/savedlinks
https://api.idxbroker.com/clients/savedlinks/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 200/204 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing client's saved link
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in broken saved links.
/clients/savedlinks
https://api.idxbroker.com/savedlinks/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| savedLinksID | number |
The ID of a client's saved link |
HTTP/1.1 200/204 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Create a new client saved link.
/clients/savedlinks
$url = 'https://api.idxbroker.com/clients/savedlinks';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a client saved link is successfully created, the new saved link's ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
Create a new client saved link.
/clients/savedlinks
$url = 'https://api.idxbroker.com/clients/savedlinks';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a client saved link is successfully created, the new saved link's ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 saved links."
Create a new client saved link.
/clients/savedlinks
$url = 'https://api.idxbroker.com/clients/savedlinks';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a client saved link is successfully created, the new saved link's ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 saved links."
Create a new client saved link.
/clients/savedlinks
$url = 'https://api.idxbroker.com/clients/savedlinks';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a client saved link is successfully created, the new saved link's ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 saved links."
Create a new client saved link.
/clients/savedlinks
$url = 'https://api.idxbroker.com/clients/savedlinks';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a client saved link is successfully created, the new saved link's ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 saved links."
Create a new client saved link.
/clients/savedlinks
$url = 'https://api.idxbroker.com/clients/savedlinks';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a client saved link is successfully created, the new saved link's ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 saved links."
Create a new client saved link.
/clients/savedlinks
$url = 'https://api.idxbroker.com/clients/savedlinks';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a client saved link is successfully created, the new saved link's ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 saved links."
Create a new client saved link.
/clients/savedlinks
$url = 'https://api.idxbroker.com/clients/savedlinks';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a client saved link is successfully created, the new saved link's ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 saved links."
Create a new client saved link.
/clients/savedlinks
$url = 'https://api.idxbroker.com/clients/savedlinks';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a client saved link is successfully created, the new saved link's ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 saved links."
Create a new client saved link.
/clients/savedlinks
$url = 'https://api.idxbroker.com/clients/savedlinks';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a client saved link is successfully created, the new saved link's ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 saved links."
Create a new client saved link.
/clients/savedlinks
https://api.idxbroker.com/savedlinks
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'linkName' => 'Good_side_of_tracks',
'pageTitle' => 'Good_side_of_tracks',
'linkTitle' => 'Good_side_of_tracks',
'queryString' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a client saved link is successfully created, the new saved link's ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 saved links."
Get total property count for a saved link.
/clients/savedlinks/{savedLinkID}/count
| Field | Type | Description |
|---|---|---|
| savedLinkID | number |
The saved link ID. |
| Field | Type | Description |
|---|---|---|
| count | string |
To return total property count. |
HTTP/1.1 200 OK "Total property count for the given saved link ID."
Get total property count for a saved link.
/clients/savedlinks/{savedLinkID}/count
| Field | Type | Description |
|---|---|---|
| savedLinkID | number |
The saved link ID. |
| Field | Type | Description |
|---|---|---|
| count | string |
To return total property count. |
HTTP/1.1 200 OK "Total property count for the given saved link ID."
Get total property count for a saved link.
/clients/savedlinks/{savedLinkID}/count
| Field | Type | Description |
|---|---|---|
| savedLinkID | number |
The saved link ID. |
| Field | Type | Description |
|---|---|---|
| count | string |
To return total property count. |
HTTP/1.1 200 OK "Total property count for the given saved link ID."
Get total property count for a saved link.
/clients/savedlinks/{savedLinkID}/count
| Field | Type | Description |
|---|---|---|
| savedLinkID | number |
The saved link ID. |
| Field | Type | Description |
|---|---|---|
| count | string |
To return total property count. |
HTTP/1.1 200 OK "Total property count for the given saved link ID."
Returns all the information for the client's sold and pending properties. That is, those that have been removed from their MLS data.
/clients/soldpending
https://api.idxbroker.com/clients/soldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "Sold/pending properties on the account."
Returns all the information for the client's sold and pending properties. That is, those that have been removed from their MLS data.
/clients/soldpending
https://api.idxbroker.com/clients/soldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "Sold/pending properties on the account."
Returns a basic set of information for all of the client's sold and pending properties. That is, those that have been removed from their MLS data.
/clients/soldpending
https://api.idxbroker.com/clients/soldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "Sold/pending properties on the account."
Returns a basic set of information for all of the client's sold and pending properties. That is, those that have been removed from their MLS data.
/clients/soldpending
https://api.idxbroker.com/clients/soldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "Sold/pending properties on the account."
Returns a basic set of information for all of the client's sold and pending properties. That is, those that have been removed from their MLS data.
/clients/soldpending
https://api.idxbroker.com/clients/soldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "Sold/pending properties on the account."
Returns a basic set of information for all of the client's sold and pending properties. That is, those that have been removed from their MLS data.
/clients/soldpending
https://api.idxbroker.com/clients/soldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "Sold/pending properties on the account."
Returns a basic set of information for all of the client's sold and pending properties. That is, those that have been removed from their MLS data.
/clients/soldpending
https://api.idxbroker.com/clients/soldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "Sold/pending properties on the account."
Returns a basic set of information for all of the client's sold and pending properties. That is, those that have been removed from their MLS data.
/clients/soldpending
https://api.idxbroker.com/clients/soldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Sold/pending properties on the account."
Returns a basic set of information for all of the client's sold and pending properties. That is, those that have been removed from their MLS data.
/clients/soldpending
https://api.idxbroker.com/clients/soldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Sold/pending properties on the account."
Returns a basic set of information for all of the client's sold and pending properties. That is, those that have been removed from their MLS data.
/clients/soldpending
https://api.idxbroker.com/clients/soldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Sold/pending properties on the account."
Returns a basic set of information for all of the client's sold and pending properties. That is, those that have been removed from their MLS data.
/clients/soldpending
https://api.idxbroker.com/clients/soldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Sold/pending properties on the account."
Returns a basic set of information for all of the client's sold and pending properties. That is, those that have been removed from their MLS data.
/clients/soldpending
https://api.idxbroker.com/clients/soldpending
HTTP/1.1 200 OK "Sold/pending properties on the account."
Remove a client's subheader
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of subheaders.
/clients/subheaders
https://api.idxbroker.com/clients/subheaders/123
https://api.idxbroker.com/clients/subheaders/batch
// Note: For batch deletes, a JSON object must be supplied as POST data,
// containing the ids you wish to delete.
// PHP Example:
$data = [
'ids' => [1, 2, 3]
];
$data = json_encode($data); // Encode as JSON, then include as body of request.
| Field | Type | Description |
|---|---|---|
| subheaderID | number |
The id of a subheader. |
HTTP/1.1 200 OK
{
"deleted": [
"1",
"2"
],
"not-found": [
"3"
]
}
HTTP/1.1 204 OK
HTTP/1.1 400 "Invalid or missing ID(s) will result in 400 error".
HTTP/1.1 500 "Failure to delete the widget."
Get all client subheaders.
/clients/subheaders
https://api.idxbroker.com/clients/subheaders
HTTP/1.1 200 OK
[
{
"id": 123,
"type": "page",
"category": "",
"pageID": 1,
"subheader": "<p>Subheader<\/p>"
},
{
"id": 124,
"type": "page",
"category": "",
"pageID": 2,
"subheader": "<p>Subheader<\/p>"
},
]
Edit an existing subheader, or multiple subheaders.
/clients/subheaders
// Note: The updatable fields need to be submitted in the request body
// as JSON, and your request must include a header 'content-type' set to
// 'application/json'
// Example 1: Editing one subheader.
$url = 'https://api.idxbroker.com/clients/subheaders/1'; // The subheader's id
$data = array(
'subheader' => '<p>New Subheader Content</p>'
);
$body = json_encode($data);
// Note: The updatable fields need to be submitted in the request body
// as JSON, and your request must include a header 'content-type' set to
// 'application/json'
// Example 2: Editing multiple subheaders at once:
$url = 'https://api.idxbroker.com/clients/subheaders/batch';
$data = array(
[
'id' => 1,
'subheader' => '<p>New subheader content for id 1</p>'
],
[
'id' => 2,
'subheader' => '<p>New subheader content for id 2</p>'
],
[
'id' => 3,
'subheader' => '<p>A non-existent subheader.</p>'
]
);
$body = json_encode($data);
HTTP/1.1 204 OK "All submitted subheaders are successfully updated."
HTTP/1.1 200 "Information about result."
{
"updated": [
"1",
"2"
],
"not-found": [
"3"
]
}
HTTP/1.1 400
Create a new subheader.
/clients/subheaders
$url = 'https://api.idxbroker.com/clients/subheaders';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example 1:
$data = array(
'type' => 'global',
'category' => '',
'pageID' => 0,
'subheader' => '<p>Global Subheader Content</p>'
);
$data = http_build_query($data);
// Example 2:
$data = array(
'type' => 'page',
'category' => 'search',
'pageID' => 1000,
'subheader' => '<p>Search Page 1000 Subheader Content</p>'
);
$data = http_build_query($data);
HTTP/1.1 200 OK "If a subheader is successfully created, the new subheader's ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 400 "Informative errors."
Get a single client subheader.
/clients/subheaders/{subheaderID}
https://api.idxbroker.com/clients/subheaders/123
| Field | Type | Description |
|---|---|---|
| subheaderID | number |
The id of a subheader. |
HTTP/1.1 200 OK
{
"id": 123,
"type": "page",
"category": "",
"pageID": 1,
"subheader": "<p>Subheader<\/p>"
}
Remove a clients supplemental property.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of supplemental properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental/123
| Field | Type | Description |
|---|---|---|
| listingID | number |
The listingID of a supplmental property. |
HTTP/1.1 204 OK
Remove a clients supplemental property.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of supplemental properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental/123
| Field | Type | Description |
|---|---|---|
| listingID | number |
The listingID of a supplmental property. |
HTTP/1.1 204 OK
Remove a clients supplemental property.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of supplemental properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental/123
| Field | Type | Description |
|---|---|---|
| listingID | number |
The listingID of a supplmental property. |
HTTP/1.1 204 OK
Remove a clients supplemental property.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of supplemental properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental/123
| Field | Type | Description |
|---|---|---|
| listingID | number |
The listingID of a supplmental property. |
HTTP/1.1 204 OK
Remove a clients supplemental property.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of supplemental properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental/123
| Field | Type | Description |
|---|---|---|
| listingID | number |
The listingID of a supplmental property. |
HTTP/1.1 204 OK
Remove a clients supplemental property.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of supplemental properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental/123
| Field | Type | Description |
|---|---|---|
| listingID | number |
The listingID of a supplmental property. |
HTTP/1.1 204 OK
Remove a clients supplemental property.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of supplemental properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental/123
| Field | Type | Description |
|---|---|---|
| listingID | number |
The listingID of a supplmental property. |
HTTP/1.1 204 OK
Remove a clients supplemental property.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of supplemental properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental/123
| Field | Type | Description |
|---|---|---|
| listingID | number |
The listingID of a supplmental property. |
HTTP/1.1 204 OK
Remove a clients supplemental property.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of supplemental properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental/123
| Field | Type | Description |
|---|---|---|
| listingID | number |
The listingID of a supplmental property. |
HTTP/1.1 204 OK
Remove a clients supplemental property.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of supplemental properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental/123
| Field | Type | Description |
|---|---|---|
| listingID | number |
The listingID of a supplmental property. |
HTTP/1.1 204 OK
Remove a clients supplemental property.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of supplemental properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental/123
| Field | Type | Description |
|---|---|---|
| listingID | number |
The listingID of a supplmental property. |
HTTP/1.1 204 OK
Returns a basic set of information for all of the client's supplemental (non-MLS) properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "Supplemental properties on the account."
Returns a basic set of information for all of the client's supplemental (non-MLS) properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "Supplemental properties on the account."
Returns a basic set of information for all of the client's supplemental (non-MLS) properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "Supplemental properties on the account."
Returns a basic set of information for all of the client's supplemental (non-MLS) properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "Supplemental properties on the account."
Returns a basic set of information for all of the client's supplemental (non-MLS) properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "Supplemental properties on the account."
Returns a basic set of information for all of the client's supplemental (non-MLS) properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "Supplemental properties on the account."
Returns a basic set of information for all of the client's supplemental (non-MLS) properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "Supplemental properties on the account."
Returns a basic set of information for all of the client's supplemental (non-MLS) properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Supplemental properties on the account."
Returns a basic set of information for all of the client's supplemental (non-MLS) properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Supplemental properties on the account."
Returns a basic set of information for all of the client's supplemental (non-MLS) properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Supplemental properties on the account."
Returns a basic set of information for all of the client's supplemental (non-MLS) properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Supplemental properties on the account."
Returns a basic set of information for all of the client's supplemental (non-MLS) properties.
/clients/supplemental
https://api.idxbroker.com/clients/supplemental
HTTP/1.1 200 OK "Supplemental properties on the account."
Update an existing supplemental listing.
Note: if updating images, existing images are deleted and the new images are inserted instead for the listing.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental/123';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| listingID | number |
The supplemental listing ID |
HTTP/1.1 200 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing supplemental listing.
Note: if updating images, existing images are deleted and the new images are inserted instead for the listing.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental/123';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| listingID | number |
The supplemental listing ID |
HTTP/1.1 200 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing supplemental listing.
Note: if updating images, existing images are deleted and the new images are inserted instead for the listing.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental/123';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| listingID | number |
The supplemental listing ID |
HTTP/1.1 200 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing supplemental listing.
Note: if updating images, existing images are deleted and the new images are inserted instead for the listing.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental/123';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| listingID | number |
The supplemental listing ID |
HTTP/1.1 200 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing supplemental listing.
Note: if updating images, existing images are deleted and the new images are inserted instead for the listing.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental/123';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| listingID | number |
The supplemental listing ID |
HTTP/1.1 200 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing supplemental listing.
Note: if updating images, existing images are deleted and the new images are inserted instead for the listing.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental/123';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| listingID | number |
The supplemental listing ID |
HTTP/1.1 200 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing supplemental listing.
Note: if updating images, existing images are deleted and the new images are inserted instead for the listing.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental/123';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| listingID | number |
The supplemental listing ID |
HTTP/1.1 200 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing supplemental listing.
Note: if updating images, existing images are deleted and the new images are inserted instead for the listing.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental/123';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| listingID | number |
The supplemental listing ID |
HTTP/1.1 200 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Update an existing supplemental listing.
Note: if updating images, existing images are deleted and the new images are inserted instead for the listing.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental/123';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| listingID | number |
The supplemental listing ID |
HTTP/1.1 200 OK "if no POST data is supplied, then a list of updatable fields with format information is returned, otherwise on success 204 is returned."
Create a new supplemental listing.
Note: likeIdxID, likeMlsPtID and zipcode fields are required.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'zipcode' => '97402',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a supplemental listing is successfully created, the new supplemental listing ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 supplmental listings."
Create a new supplemental listing.
Note: likeIdxID, likeMlsPtID and zipcode fields are required.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'zipcode' => '97402',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a supplemental listing is successfully created, the new supplemental listing ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 supplmental listings."
Create a new supplemental listing.
Note: likeIdxID, likeMlsPtID and zipcode fields are required.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'zipcode' => '97402',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a supplemental listing is successfully created, the new supplemental listing ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 supplmental listings."
Create a new supplemental listing.
Note: likeIdxID, likeMlsPtID and zipcode fields are required.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'zipcode' => '97402',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a supplemental listing is successfully created, the new supplemental listing ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 supplmental listings."
Create a new supplemental listing.
Note: likeIdxID, likeMlsPtID and zipcode fields are required.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'zipcode' => '97402',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a supplemental listing is successfully created, the new supplemental listing ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 supplmental listings."
Create a new supplemental listing.
Note: likeIdxID, likeMlsPtID and zipcode fields are required.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'zipcode' => '97402',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a supplemental listing is successfully created, the new supplemental listing ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 supplmental listings."
Create a new supplemental listing.
Note: likeIdxID, likeMlsPtID and zipcode fields are required.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'zipcode' => '97402',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a supplemental listing is successfully created, the new supplemental listing ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 supplmental listings."
Create a new supplemental listing.
Note: likeIdxID, likeMlsPtID and zipcode fields are required.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'zipcode' => '97402',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a supplemental listing is successfully created, the new supplemental listing ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 supplmental listings."
Create a new supplemental listing.
Note: likeIdxID, likeMlsPtID and zipcode fields are required.
/clients/supplemental
$url = 'https://api.idxbroker.com/clients/supplemental';
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// Example:
$data = array(
'likeIdxID' => 'a001',
'likeMlsPtID' => '1',
'zipcode' => '97402',
'images' => array('http://example.com/image1.jpg', 'http://example.com/image2.jpg')
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a supplemental listing is successfully created, the new supplemental listing ID will be returned. If no PUT data is supplied, then a list of updatable fields with format information is returned."
HTTP/1.1 417 "This action is not allowed if the client has more than 1000 supplmental listings."
Gathers all the pages system pages (search, featured, contact, etc) that can be directly linked to without additional property information being included in the URL.
/clients/systemlinks
https://api.idxbroker.com/clients/systemlinks?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK
"The name, unique ID, and URL for all system links on the account. Additionally there is a boolean named systemresults."
"If true this is a property results page that requires additional parameters. This means the url can be useful when dynamically building results page links but should not be linked to directly."
"When a client has more than one MLS on their account, listings for search pages that can vary by MLS ID will include a subpages array element."
Gathers all the pages system pages (search, featured, contact, etc) that can be directly linked to without additional property information being included in the URL.
/clients/systemlinks
https://api.idxbroker.com/clients/systemlinks?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK
"The name, unique ID, and URL for all system links on the account. Additionally there is a boolean named systemresults."
"If true this is a property results page that requires additional parameters. This means the url can be useful when dynamically building results page links but should not be linked to directly."
"When a client has more than one MLS on their account, listings for search pages that can vary by MLS ID will include a subpages array element."
Gathers all the pages system pages (search, featured, contact, etc) that can be directly linked to without additional property information being included in the URL.
/clients/systemlinks
https://api.idxbroker.com/clients/systemlinks?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK
"The name, unique ID, and URL for all system links on the account. Additionally there is a boolean named systemresults."
"If true this is a property results page that requires additional parameters. This means the url can be useful when dynamically building results page links but should not be linked to directly."
"When a client has more than one MLS on their account, listings for search pages that can vary by MLS ID will include a subpages array element."
Gathers all the pages system pages (search, featured, contact, etc) that can be directly linked to without additional property information being included in the URL.
/clients/systemlinks
https://api.idxbroker.com/clients/systemlinks?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK
"The name, unique ID, and URL for all system links on the account. Additionally there is a boolean named systemresults."
"If true this is a property results page that requires additional parameters. This means the url can be useful when dynamically building results page links but should not be linked to directly."
"When a client has more than one MLS on their account, listings for search pages that can vary by MLS ID will include a subpages array element."
Gathers all the pages system pages (search, featured, contact, etc) that can be directly linked to without additional property information being included in the URL.
/clients/systemlinks
https://api.idxbroker.com/clients/systemlinks?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK
"The name, unique ID, and URL for all system links on the account. Additionally there is a boolean named systemresults."
"If true this is a property results page that requires additional parameters. This means the url can be useful when dynamically building results page links but should not be linked to directly."
"When a client has more than one MLS on their account, listings for search pages that can vary by MLS ID will include a subpages array element."
Gathers all the pages system pages (search, featured, contact, etc) that can be directly linked to without additional property information being included in the URL.
/clients/systemlinks
https://api.idxbroker.com/clients/systemlinks?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK
"The name, unique ID, and URL for all system links on the account. Additionally there is a boolean named systemresults."
"If true this is a property results page that requires additional parameters. This means the url can be useful when dynamically building results page links but should not be linked to directly."
"When a client has more than one MLS on their account, listings for search pages that can vary by MLS ID will include a subpages array element."
Gathers all the pages system pages (search, featured, contact, etc) that can be directly linked to without additional property information being included in the URL.
/clients/systemlinks
https://api.idxbroker.com/clients/systemlinks?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK
"The name, unique ID, and URL for all system links on the account. Additionally there is a boolean named systemresults."
"If true this is a property results page that requires additional parameters. This means the url can be useful when dynamically building results page links but should not be linked to directly."
"When a client has more than one MLS on their account, listings for search pages that can vary by MLS ID will include a subpages array element."
Gathers all the pages system pages (search, featured, contact, etc) that can be directly linked to without additional property information being included in the URL.
/clients/systemlinks
https://api.idxbroker.com/clients/systemlinks?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK
"The name, unique ID, and URL for all system links on the account. Additionally there is a boolean named systemresults."
"If true this is a property results page that requires additional parameters. This means the url can be useful when dynamically building results page links but should not be linked to directly."
"When a client has more than one MLS on their account, listings for search pages that can vary by MLS ID will include a subpages array element."
Gathers all the pages system pages (search, featured, contact, etc) that can be directly linked to without additional property information being included in the URL.
/clients/systemlinks
https://api.idxbroker.com/clients/systemlinks?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK
"The name, unique ID, and URL for all system links on the account. Additionally there is a boolean named systemresults."
"If true this is a property results page that requires additional parameters. This means the url can be useful when dynamically building results page links but should not be linked to directly."
"When a client has more than one MLS on their account, listings for search pages that can vary by MLS ID will include a subpages array element."
Gathers all the pages system pages (search, featured, contact, etc) that can be directly linked to without additional property information being included in the URL.
/clients/systemlinks
https://api.idxbroker.com/clients/systemlinks?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK
"The name, unique ID, and URL for all system links on the account. Additionally there is a boolean named systemresults."
"If true this is a property results page that requires additional parameters. This means the url can be useful when dynamically building results page links but should not be linked to directly."
"When a client has more than one MLS on their account, listings for search pages that can vary by MLS ID will include a subpages array element."
Gathers all the pages system pages (search, featured, contact, etc) that can be directly linked to without additional property information being included in the URL.
/clients/systemlinks
https://api.idxbroker.com/clients/systemlinks?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK
"The name, unique ID, and URL for all system links on the account. Additionally there is a boolean named systemresults."
"If true this is a property results page that requires additional parameters. This means the url can be useful when dynamically building results page links but should not be linked to directly."
"When a client has more than one MLS on their account, listings for search pages that can vary by MLS ID will include a subpages array element."
Gathers all the pages system pages (search, featured, contact, etc) that can be directly linked to without additional property information being included in the URL.
/clients/systemlinks
https://api.idxbroker.com/clients/systemlinks
HTTP/1.1 200 OK
"The name, unique ID, and URL for all system links on the account. Additionally there is a boolean named systemresults."
"If true this is a property results page that requires additional parameters. This means the url can be useful when dynamically building results page links but should not be linked to directly."
"When a client has more than one MLS on their account, listings for search pages that can vary by MLS ID will include a subpages array element."
Gathers all javascript widgets (non-legacy) currently on the user's account. These widgets can then be placed on the user's main site via the included URLs.
/clients/widgets
https://api.idxbroker.com/clients/widgets?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "The name, unique ID, URL, and options for all javascript widgets that have been created on the user's account."
Create a new javascript widget.
/clients/widgets
https://api.idxbroker.com/clients/widgets
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data. Each specific widget type has their own set of valid options and invalid options will be ignored.
// Option examples below will indicate the input type and any single pipe characters indicate 'or', if a string type option has many specific valid values.
// Example:
$data = [
'name' => 'New Widgets Name',
'type' => 'widgetType',
'options' => [...]
];
$data = http_build_query($data); // encode and & delineate
// Available Widget Specific Options:
// Virtual Showings Widget (widgetType: virtualShowings)
[
'market' => [
'idxID' => 'string',
'type' => 'city|county|zipcode',
'masterListAreaID' => 'integer'
],
'minPrice' => 'integer',
'maxPrice' => 'integer',
'minBedrooms' => 'integer',
'minBathrooms' => 'integer',
'minSquareFeet' => 'integer',
'layout' => 'horizontal|vertical',
'css' => 'string',
];
// Market Report Widget (widgetType: marketReport)
[
'market' => [
'idxID' => 'idxID',
'type' => 'city|county|zipcode',
'masterListAreaID' => 'integer'
],
'layout' => 'square|horizontal|vertical',
'colors' => [
'primary' => 'string',
'secondary' => 'string',
'tertiary' => 'string',
'quaternary' => 'string',
'buttonText' => 'string',
'statisticsText' => 'string'
],
'css' => 'string'
];
// Listings Showcase Widget (widgetType: listingsShowcase)
[
'heading' => 'string',
'market' => [
'idxID' => 'idxID',
'type' => 'city|county|postalCode',
'masterListAreaID' => 'integer'
],
// Limit search by custom ccz lists from the account. ID of the client created custom list and the type.
// ID for dynamic mls lists use the idxID. Examples: '189-zipcode', 'b001-county'
'locationList' => 'id-county|city|zipcode',
'status' => 'active|sold',
'minPrice' => 'integer',
'maxPrice' => 'integer',
'minBedrooms' => 'integer',
'minBathrooms' => 'integer',
'minSquareFeet' => 'integer',
'sortOrder' => 'newest|pra|prd|bda|bdd|tba|tbd|sqfta|sqftd',
'maxNumberOfColumns' => 'integer',
'maxNumberOfListings' => 'integer',
'openLinksInNewWindow' => 'boolean',
'displayViewAllResultsLink' => 'boolean',
'layout' => 'overlayed|below',
// Must be valid hex codes.
'colors' => [
'banners' => 'string',
'text' => 'string',
'priceReduced' => 'string',
'favorite' => 'string'
],
'fieldsToDisplay' => [
'showBed' => 'boolean',
'showBath' => 'boolean',
'showSqFt' => 'boolean',
'showAcres' => 'boolean',
'showSubdivision' => 'boolean',
'showPrice' => 'boolean',
'showStatus' => 'boolean',
'showAddress' => 'boolean',
'showNewListingBanner' => 'boolean',
'showOpenHouseBanner' => 'boolean',
'showPriceReducedBanner' => 'boolean',
'showVirtualTourBanner' => 'boolean',
'showFavoriteListing' => 'boolean'
],
// Great for targeting mls advanced fields or any other query filtering the same way you would with key value pairs on the front end.
'editByHandQuery' => [
'add' => '10'
'pt' => [ 1, 2, 3 ],
'key' => 'value',
'key' => 'value'
],
// Additional filtering via a polygon shape.
// Circle.
'polygonData' => [
'polyType' => 'circle',
'polyRadius' => 'numeric',
'centerLat' => 'string',
'centerLng' => 'string'
],
// Polygon. Ensure the first and the last coordinates match to complete the shape object.
'polygonData' => [
'polyType' => 'polygon',
'polyCoords' => [
[lat, lng],
[lat, lng],
[lat, lng]
]
],
'css' => 'string',
'newListingBannerThreshold' => 'integer'
];
// Listings Carousel Widget (widgetType: listingsCarousel)
// All options from the listings showcase widget in addition to:
[
'displayCarouselArrows' => 'boolean',
'enableAutoScroll' => 'boolean',
'autoScrollTimer' => 'integer',
'colors' => [
'arrows' => 'string',
'arrowBackground' => 'string'
]
];
// Prime Map Search Widget (widgetType: primeMapSearch)
// All options from the listings showcase widget (minus heading, locationList, market, maxNumberOfColumns, maxNumberOfListings), in addition to:
[
'mapStyle' => 'road|satellite|satellite_road_labels|grayscale_dark|grayscale_light|night|high_contrast_dark|high_contrast_light',
'mapControlsToDisplay' => [
'addZoomControl' => 'boolean',
'addPitchControl' => 'boolean',
'addCompassControl' => 'boolean'
],
'mapDrawingOptions' => [
'addDrawPoint' => 'boolean',
'addDrawPolygon' => 'boolean',
'addDrawLine' => 'boolean',
'addDrawCircle' => 'boolean',
'addDrawRectangle' => 'boolean',
'addEditGeometry' => 'boolean',
'addEraseGeometry' => 'boolean'
],
'mapZoom' => 'integer',
'mapCenter' => [ 44.052071, -123.086754 ]
];
HTTP/1.1 200 OK "The ID, Embed, and Preview URL of the successfully created widget in the user's account."
HTTP/1.1 400 "The required fields or data options being used to create the widget are missing or invalid."
HTTP/1.1 500 "Failure to create the new widget."
Gathers all the legacy javascript widgets currently on the user's account. These widgets can then be placed on the user's main site via the included URLs.
Note: This method replaces the "widgetsrc" method. Calls to that endpoint will be forwarded here and "widgetsrc" is listed as deprecated in the methods list.
/clients/widgets-legacy
https://api.idxbroker.com/clients/widgets-legacy?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "The name, unique ID, URL, and options for all legacy javascript widgets that have been created on the user's account."
Delete many legacy javascript widgets from the user's account.
/clients/widgets-legacy/batch
https://api.idxbroker.com/clients/widgets-legacy/batch
// Note: For batch deletes, a JSON object must be supplied as POST data,
// containing the ids you wish to delete.
// PHP Example:
$data = [
'ids' => [1, 2, 3]
];
$data = json_encode($data); // Encode as JSON, then include as body of request.
| Field | Type | Description |
|---|---|---|
| batch | string |
To delete the widgets in batch. |
HTTP/1.1 200 OK "A list of deleted IDs."
{
"deleted": [ 1, 2 ],
"not-found": [ 3, 4 ]
}
HTTP/1.1 400 "Required 'ids' field is missing or all given IDs are invalid."
HTTP/1.1 500 "Failure to delete the widgets will result in a 500 error."
Delete a single legacy javascript widget from the users account.
/clients/widgets-legacy/{id}
https://api.idxbroker.com/clients/widgets-legacy/1234
| Field | Type | Description |
|---|---|---|
| id | number |
The legacy widget ID. |
HTTP/1.1 204 OK
HTTP/1.1 400 "Invalid widget ID will result in a 400 error."
HTTP/1.1 500 "Failure to delete the widget."
Gather a single legacy javascript widget and it's settings. These widgets can then be placed on the user's main site via the included URLs.
/clients/widgets-legacy/{id}
https://api.idxbroker.com/clients/widgets-legacy/1234?rf[]=url
| Field | Type | Description |
|---|---|---|
| id | number |
The legacy widget ID. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The name, unique ID, URL, and options for a single legacy javascript widget that has been created on the user's account."
HTTP/1.1 400 "Invalid widget ID will result in 400 error".
Upgrade a legacy widget to a new widget.
/clients/widgets-legacy/{id}/upgrade
| Field | Type | Description |
|---|---|---|
| id | number |
The legacy widget ID. |
| Field | Type | Description |
|---|---|---|
| upgrade | string |
To return the upgraded widget ID. |
HTTP/1.1 200 OK "Upgrade successful for the given legacy widget ID."
HTTP/1.1 400 "Invalid widget ID."
HTTP/1.1 400 "Widget is not available for upgrade."
HTTP/1.1 500 "Failure to upgrade the legacy widget will result in a 500 error."
Delete many non-legacy javascript widgets from the user's account.
/clients/widgets/batch
https://api.idxbroker.com/clients/widgets/batch
// Note: For batch deletes, a JSON object must be supplied as POST data,
// containing the ids you wish to delete.
// PHP Example:
$data = [
'ids' => [1, 2, 3]
];
$data = json_encode($data); // Encode as JSON, then include as body of request.
| Field | Type | Description |
|---|---|---|
| batch | string |
To delete the widgets in batch. |
HTTP/1.1 200 OK "A list of deleted IDs."
{
"deleted": [ 1, 2 ],
"not-found": [ 3, 4 ]
}
HTTP/1.1 400 "Required 'ids' field is missing or all given IDs are invalid."
HTTP/1.1 500 "Failure to delete the widgets will result in a 500 error."
Batch update non-legacy javascript widget's settings from the user's account.
/clients/widgets/batch
https://api.idxbroker.com/clients/widgets/batch
// Note: For batch deletes, a JSON object must be supplied as POST data,
// with each widget object including the ID of the widget that you wish to update.
// PHP Example:
$data = [
[
'id' => 123
'name' => 'New widget name'
'options' => [...]
],
[
'id' => 124
'options' => [...]
],
];
$data = json_encode($data); // Encode as JSON, then include as body of request.
| Field | Type | Description |
|---|---|---|
| batch | string |
To update the widgets in batch. |
HTTP/1.1 200 OK "List of widget ID's that were updated."
{
"updated": [ "1", "2" ]
}
HTTP/1.1 400 "Invalid widget ID's or validation errors on invalid widget options."
HTTP/1.1 500 "Failing to update the widgets."
Delete a single non-legacy javascript widget from the user's account.
/clients/widgets/{id}
https://api.idxbroker.com/clients/widgets/1234
| Field | Type | Description |
|---|---|---|
| id | number |
The widget ID. |
HTTP/1.1 204 OK
HTTP/1.1 400 "Invalid widget ID."
HTTP/1.1 500 "Failure to delete the widget will result in a 500 error."
Gather a single javascript widgets settings, currently on the user's account. Widgets can then be placed on the user's main site via the included URLs.
/clients/widgets/{id}
https://api.idxbroker.com/clients/widgets/1234?rf[]=url
| Field | Type | Description |
|---|---|---|
| id | number |
The widget ID. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The name, unique ID, URL, and options for a single javascript widget that has been created on the user's account."
HTTP/1.1 400 "Invalid widget ID will result in 400 error."
Update a single non-legacy javascript widget's settings from the user's account.
/clients/widgets/{id}
https://api.idxbroker.com/clients/widgets/1234
// Note: For updates, a JSON object must be supplied as POST data,
// containing the widget options you wish to update. Each specific widget type has their own set of valid options.
// PHP Example:
$data = [
'name' => 'New widget name',
'heading' => 'Homes Over 500k in Fake Subdivision',
'layout' => 'overlayed',
'colors => [
'text => '#FFFFF2',
'favorite => '#FF0002'
]
];
$data = json_encode($data); // Encode as JSON, then include as body of request.
| Field | Type | Description |
|---|---|---|
| id | number |
The widget ID. |
HTTP/1.1 204 OK
HTTP/1.1 400 "Invalid widget ID or options will result in a 400 error."
HTTP/1.1 500 "Failure to update the widget."
Gather all the URLs for javascript widgets on the user's account. These widgets can then be placed on the user's main site via the included URLs.
/clients/widgetsrc
https://api.idxbroker.com/clients/widgetsrc?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The name, unique ID and URL for all javascript widgets that have been created on the user's account."
Gather all the URLs for javascript widgets on the user's account. These widgets can then be placed on the user's main site via the included URLs.
/clients/widgetsrc
https://api.idxbroker.com/clients/widgetsrc?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The name, unique ID and URL for all javascript widgets that have been created on the user's account."
Gather all the URLs for javascript widgets on the user's account. These widgets can then be placed on the user's main site via the included URLs.
/clients/widgetsrc
https://api.idxbroker.com/clients/widgetsrc?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The name, unique ID and URL for all javascript widgets that have been created on the user's account."
Gather all the URLs for javascript widgets on the user's account. These widgets can then be placed on the user's main site via the included URLs.
/clients/widgetsrc
https://api.idxbroker.com/clients/widgetsrc?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The name, unique ID and URL for all javascript widgets that have been created on the user's account."
Gather all the URLs for javascript widgets on the user's account. These widgets can then be placed on the user's main site via the included URLs.
/clients/widgetsrc
https://api.idxbroker.com/clients/widgetsrc?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The name, unique ID and URL for all javascript widgets that have been created on the user's account."
Gather all the URLs for javascript widgets on the user's account. These widgets can then be placed on the user's main site via the included URLs.
/clients/widgetsrc
https://api.idxbroker.com/clients/widgetsrc?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The name, unique ID and URL for all javascript widgets that have been created on the user's account."
Gather all the URLs for javascript widgets on the user's account. These widgets can then be placed on the user's main site via the included URLs.
/clients/widgetsrc
https://api.idxbroker.com/clients/widgetsrc?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The name, unique ID and URL for all javascript widgets that have been created on the user's account."
Gather all the URLs for javascript widgets on the user's account. These widgets can then be placed on the user's main site via the included URLs.
/clients/widgetsrc
https://api.idxbroker.com/clients/widgetsrc?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The name, unique ID and URL for all javascript widgets that have been created on the user's account."
Gather all the URLs for javascript widgets on the user's account. These widgets can then be placed on the user's main site via the included URLs.
/clients/widgetsrc
https://api.idxbroker.com/clients/widgetsrc?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The name, unique ID and URL for all javascript widgets that have been created on the user's account."
Gather all the URLs for javascript widgets on the user's account. These widgets can then be placed on the user's main site via the included URLs.
/clients/widgetsrc
https://api.idxbroker.com/clients/widgetsrc?rf[]=url
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The name, unique ID and URL for all javascript widgets that have been created on the user's account."
Gather all the URLs for javascript widgets on the user's account. These widgets can then be placed on the user's main site via the included URLs.
/clients/widgetsrc
https://api.idxbroker.com/clients/widgetsrc
HTTP/1.1 200 OK "The name, unique ID and URL for all javascript widgets that have been created on the user's account."
/clients/wrappercache
HTTP/1.1 204 OK
/clients/wrappercache
HTTP/1.1 204 OK
/clients/wrappercache
HTTP/1.1 204 OK
/clients/wrappercache
HTTP/1.1 204 OK
/clients/wrappercache
HTTP/1.1 204 OK
/clients/wrappercache
HTTP/1.1 204 OK
/clients/wrappercache
HTTP/1.1 204 OK
/clients/wrappercache
HTTP/1.1 204 OK
/clients/wrappercache
HTTP/1.1 204 OK
/clients/wrappercache
HTTP/1.1 204 OK
/clients/wrappercache
HTTP/1.1 204 OK
/clients/wrappercache
HTTP/1.1 204 OK
Returns the zipcodes available in each of a client's zipcode lists. Since a client can build any number of zipcode lists this method requires the ID of which list you want to view. To get a list of all zipcode lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
/clients/zipcodes
https://api.idxbroker.com/clients/zipcodes/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All zipcodes in a given list or, if no list ID is provided, a list of list IDs."
Returns the zipcodes available in each of a client's zipcode lists. Since a client can build any number of zipcode lists this method requires the ID of which list you want to view. To get a list of all zipcode lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
clients/zipcodes
https://api.idxbroker.com/clients/zipcodes/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All zipcodes in a given list or, if no list ID is provided, a list of list IDs."
Returns the zipcodes available in each of a client's zipcode lists. Since a client can build any number of zipcode lists this method requires the ID of which list you want to view. To get a list of all zipcode lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
clients/zipcodes
https://api.idxbroker.com/clients/zipcodes/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All zipcodes in a given list or, if no list ID is provided, a list of list IDs."
Returns the zipcodes available in each of a client's zipcode lists. Since a client can build any number of zipcode lists this method requires the ID of which list you want to view. To get a list of all zipcode lists available do not send the primary request ID. The default list on each account has the id combinedActiveMLS.
clients/zipcodes
https://api.idxbroker.com/clients/zipcodes/123
| Field | Type | Description |
|---|---|---|
| listID optional | number |
If no ID is given a list of IDs is returned. |
HTTP/1.1 200 OK "All zipcodes in a given list or, if no list ID is provided, a list of list IDs."
Update leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps. LeadID is required for each lead to be updated
// PHP Example:
$data = array(
'id[0]' => 1,
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'status[0]' => 'verified',
'id[1]' = 2,
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a leads are successfully updated the updated lead IDs will be returned. If no POST data is supplied then a list of updatable fields with format information is returned."
Update leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps. LeadID is required for each lead to be updated
// PHP Example:
$data = array(
'id[0]' => 1,
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'status[0]' => 'verified',
'id[1]' = 2,
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a leads are successfully updated the updated lead IDs will be returned. If no POST data is supplied then a list of updatable fields with format information is returned."
Update leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps. LeadID is required for each lead to be updated
// PHP Example:
$data = array(
'id[0]' => 1,
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'status[0]' => 'verified',
'id[1]' = 2,
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a leads are successfully updated the updated lead IDs will be returned. If no POST data is supplied then a list of updatable fields with format information is returned."
Update leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps. LeadID is required for each lead to be updated
// PHP Example:
$data = array(
'id[0]' = 1,
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'id[1]' = 2,
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a leads are successfully updated the updated lead IDs will be returned. If no POST data is supplied then a list of updatable fields with format information is returned."
Update leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps. LeadID is required for each lead to be updated
// PHP Example:
$data = array(
'id[0]' = 1,
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'id[1]' = 2,
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a leads are successfully updated the updated lead IDs will be returned. If no POST data is supplied then a list of updatable fields with format information is returned."
Update leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps. LeadID is required for each lead to be updated
// PHP Example:
$data = array(
'id[0]' = 1,
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'id[1]' = 2,
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a leads are successfully updated the updated lead IDs will be returned. If no POST data is supplied then a list of updatable fields with format information is returned."
Update leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps. LeadID is required for each lead to be updated
// PHP Example:
$data = array(
'id[0]' = 1,
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'id[1]' = 2,
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a leads are successfully updated the updated lead IDs will be returned. If no POST data is supplied then a list of updatable fields with format information is returned."
Update leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps. LeadID is required for each lead to be updated
// PHP Example:
$data = array(
'id[0]' = 1,
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'id[1]' = 2,
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a leads are successfully updated the updated lead IDs will be returned. If no POST data is supplied then a list of updatable fields with format information is returned."
Add leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps.
// PHP Example:
$data = array(
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'status[0]' => 'verified',
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead IDs will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Add leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps.
// PHP Example:
$data = array(
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'status[0]' => 'verified',
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead IDs will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Add leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps.
// PHP Example:
$data = array(
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'status[0]' => 'verified',
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead IDs will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Add leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps.
// PHP Example:
$data = array(
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead IDs will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Add leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps.
// PHP Example:
$data = array(
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead IDs will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Add leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps.
// PHP Example:
$data = array(
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead IDs will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Add leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps.
// PHP Example:
$data = array(
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead IDs will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Add leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps.
// PHP Example:
$data = array(
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead IDs will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Add leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps.
// PHP Example:
$data = array(
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead IDs will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Add leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps.
// PHP Example:
$data = array(
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead IDs will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Add leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps.
// PHP Example:
$data = array(
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead IDs will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Add leads in batches of up to 100 per request.
/leads/bulklead
https://api.idxbroker.com/leads/bulklead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data. Each lead field should be passed as an indexed array starting
// at and going to, at most, 100. There must not be any gaps.
// PHP Example:
$data = array(
'firstName[0]' => 'John',
'lastName[0]' => 'Doe',
'email[0]' => 'john@example.com',
'firstName[1]' => 'Aaron',
'lastName[1]' => 'Aaronson',
'email[1]' => 'aaron@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead IDs will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Remove a lead system wide.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of leads.
/leads/lead
https://api.idxbroker.com/leads/lead/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 204 OK
Remove a lead system wide.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of leads.
/leads/lead
https://api.idxbroker.com/leads/lead/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 204 OK
Remove a lead system wide.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of leads.
/leads/lead
https://api.idxbroker.com/leads/lead/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 204 OK
Remove a lead system wide.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of leads.
/leads/lead
https://api.idxbroker.com/leads/lead/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 204 OK
Remove a lead system wide.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of leads.
/leads/lead
https://api.idxbroker.com/leads/lead/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 204 OK
Remove a lead system wide.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of leads.
/leads/lead
https://api.idxbroker.com/leads/lead/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 204 OK
Remove a lead system wide.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of leads.
/leads/lead
https://api.idxbroker.com/leads/lead/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 204 OK
Remove a lead system wide.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of leads.
/leads/lead
https://api.idxbroker.com/leads/lead/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 204 OK
Remove a lead system wide.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of leads.
/leads/lead
https://api.idxbroker.com/leads/lead/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 204 OK
Remove a lead system wide.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of leads.
/leads/lead
https://api.idxbroker.com/leads/lead/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 204 OK
Remove a lead system wide.
This method is to be used at your own risk. We will NOT be held accountable for programmatic errors in your code or the improper use of search values or options within said values resulting in deletion of leads.
/leads/lead
https://api.idxbroker.com/leads/lead/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 204 OK
Get information for one or multiple leads including their last 5 viewed listings and search results and total number of viewed listings. Note: Lead traffic information is limited to 180 days.
For bandwidth and memory considerations there is a limit of 500 on the number of leads that can be returned in any single request when querying for multiple leads. Use pagination to get all leads.
/leads/lead
https://api.idxbroker.com/leads/lead?interval=24&startDatetime=2015-01-01+23:59:59&dateType=subscribeDate&sortOrder=desc
| Field | Type | Description |
|---|---|---|
| leadID optional | number |
The ID of a lead |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead, this will specify what is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| offset optional | number |
Items to skip from the beginning. |
| sortBy optional | string |
Sort leads in the order they were created. Possible values: asc, desc. |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If a lead ID is provided detailed information about that lead is returned. Otherwise simple information about all leads (limited to 500) is returned along with the pagination information to get all leads."
Get information for one or multiple leads including their last 5 viewed listings and search results and total number of viewed listings. Note: Lead traffic information is limited to 180 days.
For bandwidth and memory considerations there is a limit of 500 on the number of leads that can be returned in any single request when querying for multiple leads. Use pagination to get all leads.
/leads/lead
https://api.idxbroker.com/leads/lead?interval=24&startDatetime=2015-01-01+23:59:59&dateType=subscribeDate&sortOrder=desc
| Field | Type | Description |
|---|---|---|
| leadID optional | number |
The ID of a lead |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead, this will specify what is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| offset optional | number |
Items to skip from the beginning. |
| sortBy optional | string |
Sort leads in the order they were created. Possible values: asc, desc. |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If a lead ID is provided detailed information about that lead is returned. Otherwise simple information about all leads (limited to 500) is returned along with the pagination information to get all leads."
Get information for one or multiple leads.
For bandwidth and memory considerations there is a limit of 500 on the number of leads that can be returned in any single request when querying for multiple leads. Use pagination to get all leads.
/leads/lead
https://api.idxbroker.com/leads/lead?interval=24&startDatetime=2015-01-01+23:59:59&dateType=subscribeDate
| Field | Type | Description |
|---|---|---|
| leadID optional | number |
The ID of a lead |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead, this will specify what is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| offset optional | number |
Items to skip from the beginning. |
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If a lead ID is provided detailed information about that lead is returned. Otherwise simple information about all leads (limited to 500) is returned along with the pagination information to get all leads."
Get information for one or multiple leads.
/leads/lead
https://api.idxbroker.com/leads/lead?interval=24&startDatetime=2015-01-01+23:59:59&dateType=subscribeDate
| Field | Type | Description |
|---|---|---|
| leadID optional | number |
The ID of a lead |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead, this will specify what is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "If a lead ID is provided detailed information about that lead is returned. Otherwise simple information about all leads is returned."
Get information for one or multiple leads.
/leads/lead
https://api.idxbroker.com/leads/lead?interval=24&startDatetime=2015-01-01+23:59:59&dateType=subscribeDate
| Field | Type | Description |
|---|---|---|
| leadID optional | number |
The ID of a lead |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead, this will specify what is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "If a lead ID is provided detailed information about that lead is returned. Otherwise simple information about all leads is returned."
Get information for one or multiple leads.
/leads/lead
https://api.idxbroker.com/leads/lead?interval=24&startDatetime=2015-01-01+23:59:59&dateType=subscribeDate
| Field | Type | Description |
|---|---|---|
| leadID optional | number |
The ID of a lead |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead, this will specify what is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "If a lead ID is provided detailed information about that lead is returned. Otherwise simple information about all leads is returned."
Get information for one or multiple leads.
/leads/lead
https://api.idxbroker.com/leads/lead?interval=24&startDatetime=2015-01-01+23:59:59&dateType=subscribeDate
| Field | Type | Description |
|---|---|---|
| leadID optional | number |
The ID of a lead |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead, this will specify what is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "If a lead ID is provided detailed information about that lead is returned. Otherwise simple information about all leads is returned."
Get information for one or multiple leads.
/leads/lead
https://api.idxbroker.com/leads/lead?interval=24&startDatetime=2015-01-01+23:59:59&dateType=subscribeDate
| Field | Type | Description |
|---|---|---|
| leadID optional | number |
The ID of a lead |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead, this will specify what is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If a lead ID is provided detailed information about that lead is returned. Otherwise simple information about all leads is returned."
Get information for one or multiple leads.
/leads/lead
https://api.idxbroker.com/leads/lead?interval=24&startDatetime=2015-01-01+23:59:59&dateType=subscribeDate
| Field | Type | Description |
|---|---|---|
| leadID optional | number |
The ID of a lead |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead, this will specify what is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If a lead ID is provided detailed information about that lead is returned. Otherwise simple information about all leads is returned."
Get information for one or multiple leads.
/leads/lead
https://api.idxbroker.com/leads/lead?interval=24&startDatetime=2015-01-01+23:59:59&dateType=subscribeDate
| Field | Type | Description |
|---|---|---|
| leadID optional | number |
The ID of a lead |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead, this will specify what is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If a lead ID is provided detailed information about that lead is returned. Otherwise simple information about all leads is returned."
Get information for one or multiple leads.
/leads/lead
https://api.idxbroker.com/leads/lead?interval=24&startDatetime=2015-01-01+23:59:59&dateType=subscribeDate
| Field | Type | Description |
|---|---|---|
| leadID optional | number |
The ID of a lead |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead, this will specify what is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If a lead ID is provided detailed information about that lead is returned. Otherwise simple information about all leads is returned."
Get information for one or multiple leads.
/leads/lead
https://api.idxbroker.com/leads/lead/1
| Field | Type | Description |
|---|---|---|
| leadID optional | number |
The ID of a lead |
HTTP/1.1 200 OK "If a lead ID is provided detailed information about that lead is returned. Otherwise simple information about all leads is returned."
Update the information for one lead specified by the primary request ID.
/leads/lead
https://api.idxbroker.com/leads/lead/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com',
'status' => 'verified'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead |
HTTP/1.1 200 OK "If no POST data is supplied then a list of updatable fields with format information is returned."
Update the information for one lead specified by the primary request ID.
/leads/lead
https://api.idxbroker.com/leads/lead/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com',
'status' => 'verified'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead |
HTTP/1.1 200 OK "If no POST data is supplied then a list of updatable fields with format information is returned."
Update the information for one lead specified by the primary request ID.
/leads/lead
https://api.idxbroker.com/leads/lead/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com',
'status' => 'verified'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead |
HTTP/1.1 200 OK "If no POST data is supplied then a list of updatable fields with format information is returned."
Update the information for one lead specified by the primary request ID.
/leads/lead
https://api.idxbroker.com/leads/lead/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead |
HTTP/1.1 200 OK "If no POST data is supplied then a list of updatable fields with format information is returned."
Update the information for one lead specified by the primary request ID.
/leads/lead
https://api.idxbroker.com/leads/lead/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead |
HTTP/1.1 200 OK "If no POST data is supplied then a list of updatable fields with format information is returned."
Update the information for one lead specified by the primary request ID.
/leads/lead
https://api.idxbroker.com/leads/lead/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead |
HTTP/1.1 200 OK "If no POST data is supplied then a list of updatable fields with format information is returned."
Update the information for one lead specified by the primary request ID.
/leads/lead
https://api.idxbroker.com/leads/lead/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead |
HTTP/1.1 200 OK "If no POST data is supplied then a list of updatable fields with format information is returned."
Update the information for one lead specified by the primary request ID.
/leads/lead
https://api.idxbroker.com/leads/lead/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead |
HTTP/1.1 200 OK "If no POST data is supplied then a list of updatable fields with format information is returned."
Update the information for one lead specified by the primary request ID.
/leads/lead
https://api.idxbroker.com/leads/lead/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead |
HTTP/1.1 200 OK "If no POST data is supplied then a list of updatable fields with format information is returned."
Update the information for one lead specified by the primary request ID.
/leads/lead
https://api.idxbroker.com/leads/lead/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead |
HTTP/1.1 200 OK "If no POST data is supplied then a list of updatable fields with format information is returned."
Update the information for one lead specified by the primary request ID.
/leads/lead
https://api.idxbroker.com/leads/lead/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead |
HTTP/1.1 200 OK "If no POST data is supplied then a list of updatable fields with format information is returned."
Update the information for one lead specified by the primary request ID.
/leads/lead
https://api.idxbroker.com/leads/lead/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead |
HTTP/1.1 200 OK "If no POST data is supplied then a list of updatable fields with format information is returned."
Create a new lead.
Special Note: Currently the API cannot differentiate between a lead rejected due to server error or one rejected due to bad email address. The lead system requires email addresses that are correctly formatted to cut down on garbage accounts, and they need to have a valid MX record. Most 500 error from this method are a result of bad email addresses. In future versions we will differentiate the error and make the MX record requirement optional.
/leads/lead
https://api.idxbroker.com/leads/lead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com',
'status' => 'verified'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead.
Special Note: Currently the API cannot differentiate between a lead rejected due to server error or one rejected due to bad email address. The lead system requires email addresses that are correctly formatted to cut down on garbage accounts, and they need to have a valid MX record. Most 500 error from this method are a result of bad email addresses. In future versions we will differentiate the error and make the MX record requirement optional.
/leads/lead
https://api.idxbroker.com/leads/lead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com',
'status' => 'verified'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead.
Special Note: Currently the API cannot differentiate between a lead rejected due to server error or one rejected due to bad email address. The lead system requires email addresses that are correctly formatted to cut down on garbage accounts, and they need to have a valid MX record. Most 500 error from this method are a result of bad email addresses. In future versions we will differentiate the error and make the MX record requirement optional.
/leads/lead
https://api.idxbroker.com/leads/lead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com',
'status' => 'verified'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead.
Special Note: Currently the API cannot differentiate between a lead rejected due to server error or one rejected due to bad email address. The lead system requires email addresses that are correctly formatted to cut down on garbage accounts, and they need to have a valid MX record. Most 500 error from this method are a result of bad email addresses. In future versions we will differentiate the error and make the MX record requirement optional.
/leads/lead
https://api.idxbroker.com/leads/lead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead.
Special Note: Currently the API cannot differentiate between a lead rejected due to server error or one rejected due to bad email address. The lead system requires email addresses that are correctly formatted to cut down on garbage accounts, and they need to have a valid MX record. Most 500 error from this method are a result of bad email addresses. In future versions we will differentiate the error and make the MX record requirement optional.
/leads/lead
https://api.idxbroker.com/leads/lead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead.
Special Note: Currently the API cannot differentiate between a lead rejected due to server error or one rejected due to bad email address. The lead system requires email addresses that are correctly formatted to cut down on garbage accounts, and they need to have a valid MX record. Most 500 error from this method are a result of bad email addresses. In future versions we will differentiate the error and make the MX record requirement optional.
/leads/lead
https://api.idxbroker.com/leads/lead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead.
Special Note: Currently the API cannot differentiate between a lead rejected due to server error or one rejected due to bad email address. The lead system requires email addresses that are correctly formatted to cut down on garbage accounts, and they need to have a valid MX record. Most 500 error from this method are a result of bad email addresses. In future versions we will differentiate the error and make the MX record requirement optional.
/leads/lead
https://api.idxbroker.com/leads/lead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead.
Special Note: Currently the API cannot differentiate between a lead rejected due to server error or one rejected due to bad email address. The lead system requires email addresses that are correctly formatted to cut down on garbage accounts, and they need to have a valid MX record. Most 500 error from this method are a result of bad email addresses. In future versions we will differentiate the error and make the MX record requirement optional.
/leads/lead
https://api.idxbroker.com/leads/lead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead.
Special Note: Currently the API cannot differentiate between a lead rejected due to server error or one rejected due to bad email address. The lead system requires email addresses that are correctly formatted to cut down on garbage accounts, and they need to have a valid MX record. Most 500 error from this method are a result of bad email addresses. In future versions we will differentiate the error and make the MX record requirement optional.
/leads/lead
https://api.idxbroker.com/leads/lead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead.
Special Note: Currently the API cannot differentiate between a lead rejected due to server error or one rejected due to bad email address. The lead system requires email addresses that are correctly formatted to cut down on garbage accounts, and they need to have a valid MX record. Most 500 error from this method are a result of bad email addresses. In future versions we will differentiate the error and make the MX record requirement optional.
/leads/lead
https://api.idxbroker.com/leads/lead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead.
Special Note: Currently the API cannot differentiate between a lead rejected due to server error or one rejected due to bad email address. The lead system requires email addresses that are correctly formatted to cut down on garbage accounts, and they need to have a valid MX record. Most 500 error from this method are a result of bad email addresses. In future versions we will differentiate the error and make the MX record requirement optional.
/leads/lead
https://api.idxbroker.com/leads/lead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead.
Special Note: Currently the API cannot differentiate between a lead rejected due to server error or one rejected due to bad email address. The lead system requires email addresses that are correctly formatted to cut down on garbage accounts, and they need to have a valid MX record. Most 500 error from this method are a result of bad email addresses. In future versions we will differentiate the error and make the MX record requirement optional.
/leads/lead
https://api.idxbroker.com/leads/lead
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'firstName' => 'John',
'lastName' => 'Doe',
'email' => 'john@example.com'
);
$data = http_build_query($data); // encode and & delineate
HTTP/1.1 200 OK "If a lead is successfully created the new lead's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Get traffic history for a specified lead.
For bandwidth and memory considerations there is a limit of 5,000 on the number of lead traffics that can be returned in any single request.
/leads/leadtraffic
https://api.idxbroker.com/leads/leadtraffic/1?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get traffic history for a specified lead.
For bandwidth and memory considerations there is a limit of 5,000 on the number of lead traffics that can be returned in any single request.
/leads/leadtraffic
https://api.idxbroker.com/leads/leadtraffic/1?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get traffic history for a specified lead.
For bandwidth and memory considerations there is a limit of 5,000 on the number of lead traffics that can be returned in any single request.
/leads/leadtraffic
https://api.idxbroker.com/leads/leadtraffic/1?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get traffic history for a specified lead.
For bandwidth and memory considerations there is a limit of 5,000 on the number of lead traffics that can be returned in any single request.
/leads/leadtraffic
https://api.idxbroker.com/leads/leadtraffic/1?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get traffic history for a specified lead.
For bandwidth and memory considerations there is a limit of 5,000 on the number of lead traffics that can be returned in any single request.
/leads/leadtraffic
https://api.idxbroker.com/leads/leadtraffic/1?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get traffic history for a specified lead.
For bandwidth and memory considerations there is a limit of 5,000 on the number of lead traffics that can be returned in any single request.
/leads/leadtraffic
https://api.idxbroker.com/leads/leadtraffic/1?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get traffic history for a specified lead.
For bandwidth and memory considerations there is a limit of 5,000 on the number of lead traffics that can be returned in any single request.
/leads/leadtraffic
https://api.idxbroker.com/leads/leadtraffic/1?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get traffic history for a specified lead.
For bandwidth and memory considerations there is a limit of 5,000 on the number of lead traffics that can be returned in any single request.
/leads/leadtraffic
https://api.idxbroker.com/leads/leadtraffic/1?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get traffic history for a specified lead.
For bandwidth and memory considerations there is a limit of 5,000 on the number of lead traffics that can be returned in any single request.
/leads/leadtraffic
https://api.idxbroker.com/leads/leadtraffic/1?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get traffic history for a specified lead.
For bandwidth and memory considerations there is a limit of 5,000 on the number of lead traffics that can be returned in any single request.
/leads/leadtraffic
https://api.idxbroker.com/leads/leadtraffic/1?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get traffic history for a specified lead.
For bandwidth and memory considerations there is a limit of 5,000 on the number of lead traffics that can be returned in any single request.
/leads/leadtraffic
https://api.idxbroker.com/leads/leadtraffic/1?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
This is a simple, access anywhere, method for getting a list of all API components available.
/leads/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/leads/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/leads/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/leads/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/leads/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/leads/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/leads/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/leads/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/leads/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/leads/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/leads/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/leads/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/leads/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/leads/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/leads/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/leads/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/leads/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/leads/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/leads/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/leads/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/leads/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/leads/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/leads/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/leads/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
Remove a lead note.
/leads/note
https://api.idxbroker.com/leads/note/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of the note to delete. |
HTTP/1.1 204 OK
Remove a lead note.
/leads/note
https://api.idxbroker.com/leads/note/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of the note to delete. |
HTTP/1.1 204 OK
Remove a lead note.
/leads/note
https://api.idxbroker.com/leads/note/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of the note to delete. |
HTTP/1.1 204 OK
Remove a lead note.
/leads/note
https://api.idxbroker.com/leads/note/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of the note to delete. |
HTTP/1.1 204 OK
Remove a lead note.
/leads/note
https://api.idxbroker.com/leads/note/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of the note to delete. |
HTTP/1.1 204 OK
Remove a lead note.
/leads/note
https://api.idxbroker.com/leads/note/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of the note to delete. |
HTTP/1.1 204 OK
Remove a lead note.
/leads/note
https://api.idxbroker.com/leads/note/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of the note to delete. |
HTTP/1.1 204 OK
Remove a lead note.
/leads/note
https://api.idxbroker.com/leads/note/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of the note to delete. |
HTTP/1.1 204 OK
Remove a lead note.
/leads/note
https://api.idxbroker.com/leads/note/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of the note to delete. |
HTTP/1.1 204 OK
Remove a lead note.
/leads/note
https://api.idxbroker.com/leads/note/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of the note to delete. |
HTTP/1.1 204 OK
Remove a lead note.
/leads/note
https://api.idxbroker.com/leads/note/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of the note to delete. |
HTTP/1.1 204 OK
Remove a lead note.
/leads/note
https://api.idxbroker.com/leads/note/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of the note to delete. |
HTTP/1.1 204 OK
Get notes for a lead.
/leads/note
https://api.idxbroker.com/leads/note/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID optional | number |
The ID of a lead's note. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead note, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Lead note information. If no note ID is sent all notes for the lead are returned. If a note ID is passed only the one note is returned."
Get notes for a lead.
/leads/note
https://api.idxbroker.com/leads/note/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID optional | number |
The ID of a lead's note. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead note, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Lead note information. If no note ID is sent all notes for the lead are returned. If a note ID is passed only the one note is returned."
Get notes for a lead.
/leads/note
https://api.idxbroker.com/leads/note/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID optional | number |
The ID of a lead's note. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead note, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Lead note information. If no note ID is sent all notes for the lead are returned. If a note ID is passed only the one note is returned."
Get notes for a lead.
/leads/note
https://api.idxbroker.com/leads/note/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID optional | number |
The ID of a lead's note. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead note, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Lead note information. If no note ID is sent all notes for the lead are returned. If a note ID is passed only the one note is returned."
Get notes for a lead.
/leads/note
https://api.idxbroker.com/leads/note/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID optional | number |
The ID of a lead's note. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead note, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Lead note information. If no note ID is sent all notes for the lead are returned. If a note ID is passed only the one note is returned."
Get notes for a lead.
/leads/note
https://api.idxbroker.com/leads/note/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID optional | number |
The ID of a lead's note. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead note, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Lead note information. If no note ID is sent all notes for the lead are returned. If a note ID is passed only the one note is returned."
Get notes for a lead.
/leads/note
https://api.idxbroker.com/leads/note/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID optional | number |
The ID of a lead's note. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead note, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Lead note information. If no note ID is sent all notes for the lead are returned. If a note ID is passed only the one note is returned."
Get notes for a lead.
/leads/note
https://api.idxbroker.com/leads/note/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID optional | number |
The ID of a lead's note. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead note, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Lead note information. If no note ID is sent all notes for the lead are returned. If a note ID is passed only the one note is returned."
Get notes for a lead.
/leads/note
https://api.idxbroker.com/leads/note/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID optional | number |
The ID of a lead's note. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead note, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Lead note information. If no note ID is sent all notes for the lead are returned. If a note ID is passed only the one note is returned."
Get notes for a lead.
/leads/note
https://api.idxbroker.com/leads/note/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID optional | number |
The ID of a lead's note. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead note, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Lead note information. If no note ID is sent all notes for the lead are returned. If a note ID is passed only the one note is returned."
Get notes for a lead.
/leads/note
https://api.idxbroker.com/leads/note/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID optional | number |
The ID of a lead's note. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead note, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "Lead note information. If no note ID is sent all notes for the lead are returned. If a note ID is passed only the one note is returned."
Get notes for a lead.
/leads/note
https://api.idxbroker.com/leads/note/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID optional | number |
The ID of a lead's note. |
HTTP/1.1 200 OK "Lead note information. If no note ID is sent all notes for the lead are returned. If a note ID is passed only the one note is returned."
Update the notes information for one lead specified by the primary request ID.
/leads/note
https://api.idxbroker.com/leads/note/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of a lead's note. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update the notes information for one lead specified by the primary request ID.
/leads/note
https://api.idxbroker.com/leads/note/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of a lead's note. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update the notes information for one lead specified by the primary request ID.
/leads/note
https://api.idxbroker.com/leads/note/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of a lead's note. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update the notes information for one lead specified by the primary request ID.
/leads/note
https://api.idxbroker.com/leads/note/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of a lead's note. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update the notes information for one lead specified by the primary request ID.
/leads/note
https://api.idxbroker.com/leads/note/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of a lead's note. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update the notes information for one lead specified by the primary request ID.
/leads/note
https://api.idxbroker.com/leads/note/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of a lead's note. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update the notes information for one lead specified by the primary request ID.
/leads/note
https://api.idxbroker.com/leads/note/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of a lead's note. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update the notes information for one lead specified by the primary request ID.
/leads/note
https://api.idxbroker.com/leads/note/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of a lead's note. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update the notes information for one lead specified by the primary request ID.
/leads/note
https://api.idxbroker.com/leads/note/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of a lead's note. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update the notes information for one lead specified by the primary request ID.
/leads/note
https://api.idxbroker.com/leads/note/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of a lead's note. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update the notes information for one lead specified by the primary request ID.
/leads/note
https://api.idxbroker.com/leads/note/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of a lead's note. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update the notes information for one lead specified by the primary request ID.
/leads/note
https://api.idxbroker.com/leads/note/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| noteID | number |
The ID of a lead's note. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead note.
/leads/note
https://api.idxbroker.com/leads/note/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead note.
/leads/note
https://api.idxbroker.com/leads/note/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead note.
/leads/note
https://api.idxbroker.com/leads/note/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead note.
/leads/note
https://api.idxbroker.com/leads/note/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead note.
/leads/note
https://api.idxbroker.com/leads/note/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead note.
/leads/note
https://api.idxbroker.com/leads/note/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead note.
/leads/note
https://api.idxbroker.com/leads/note/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead note.
/leads/note
https://api.idxbroker.com/leads/note/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead note.
/leads/note
https://api.idxbroker.com/leads/note/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead note.
/leads/note
https://api.idxbroker.com/leads/note/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead note.
/leads/note
https://api.idxbroker.com/leads/note/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead note.
/leads/note
https://api.idxbroker.com/leads/note/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'note' => 'Test note'
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a note is successfully created the new notes's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Remove a lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a property to delete. |
HTTP/1.1 204 OK
Remove a lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a property to delete. |
HTTP/1.1 204 OK
Remove a lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a property to delete. |
HTTP/1.1 204 OK
Remove a lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a property to delete. |
HTTP/1.1 204 OK
Remove a lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a property to delete. |
HTTP/1.1 204 OK
Remove a lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a property to delete. |
HTTP/1.1 204 OK
Remove a lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a property to delete. |
HTTP/1.1 204 OK
Remove a lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a property to delete. |
HTTP/1.1 204 OK
Remove a lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a property to delete. |
HTTP/1.1 204 OK
Remove a lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a property to delete. |
HTTP/1.1 204 OK
Remove a lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a property to delete. |
HTTP/1.1 204 OK
Remove a lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a property to delete. |
HTTP/1.1 204 OK
Get saved properties for a lead.
/leads/property
https://api.idxbroker.com/leads/property/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID optional | number |
The ID of a lead's saved property. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead's saved property, this will specify what is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If no property ID is passed all properties are returned. If a property ID is passed only the information for that specified property is returned."
Get saved properties for a lead.
/leads/property
https://api.idxbroker.com/leads/property/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID optional | number |
The ID of a lead's saved property. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead's saved property, this will specify what is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If no property ID is passed all properties are returned. If a property ID is passed only the information for that specified property is returned."
Get saved properties for a lead.
/leads/property
https://api.idxbroker.com/leads/property/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID optional | number |
The ID of a lead's saved property. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead's saved property, this will specify what is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If no property ID is passed all properties are returned. If a property ID is passed only the information for that specified property is returned."
Get saved properties for a lead.
/leads/property
https://api.idxbroker.com/leads/property/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID optional | number |
The ID of a lead's saved property. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead's saved property, this will specify what is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If no property ID is passed all properties are returned. If a property ID is passed only the information for that specified property is returned."
Get saved properties for a lead.
/leads/property
https://api.idxbroker.com/leads/property/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID optional | number |
The ID of a lead's saved property. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead's saved property, this will specify what is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If no property ID is passed all properties are returned. If a property ID is passed only the information for that specified property is returned."
Get saved properties for a lead.
/leads/property
https://api.idxbroker.com/leads/property/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID optional | number |
The ID of a lead's saved property. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead's saved property, this will specify what is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If no property ID is passed all properties are returned. If a property ID is passed only the information for that specified property is returned."
Get saved properties for a lead.
/leads/property
https://api.idxbroker.com/leads/property/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID optional | number |
The ID of a lead's saved property. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead's saved property, this will specify what is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If no property ID is passed all properties are returned. If a property ID is passed only the information for that specified property is returned."
Get saved properties for a lead.
/leads/property
https://api.idxbroker.com/leads/property/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID optional | number |
The ID of a lead's saved property. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead's saved property, this will specify what is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If no property ID is passed all properties are returned. If a property ID is passed only the information for that specified property is returned."
Get saved properties for a lead.
/leads/property
https://api.idxbroker.com/leads/property/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID optional | number |
The ID of a lead's saved property. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead's saved property, this will specify what is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If no property ID is passed all properties are returned. If a property ID is passed only the information for that specified property is returned."
Get saved properties for a lead.
/leads/property
https://api.idxbroker.com/leads/property/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID optional | number |
The ID of a lead's saved property. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
there are several dates associated with a lead's saved property, this will specify what is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If no property ID is passed all properties are returned. If a property ID is passed only the information for that specified property is returned."
Get saved properties for a lead.
/leads/property
https://api.idxbroker.com/leads/property/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID optional | number |
The ID of a lead's saved property. |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetim |
there are several dates associated with a lead's saved property, this will specify what is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "If no property ID is passed all properties are returned. If a property ID is passed only the information for that specified property is returned."
Get saved properties for a lead.
/leads/property
https://api.idxbroker.com/leads/property/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID optional | number |
The ID of a lead's saved property. |
HTTP/1.1 200 OK "If no property ID is passed all properties are returned. If a property ID is passed only the information for that specified property is returned."
Update an existing lead's saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a lead's saved property. |
HTTP/1.1 200 OK If no POST data is supplied then a list of updatable fields with format information is returned.
Update an existing lead's saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a lead's saved property. |
HTTP/1.1 200 OK If no POST data is supplied then a list of updatable fields with format information is returned.
Update an existing lead's saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a lead's saved property. |
HTTP/1.1 200 OK If no POST data is supplied then a list of updatable fields with format information is returned.
Update an existing lead's saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a lead's saved property. |
HTTP/1.1 200 OK If no POST data is supplied then a list of updatable fields with format information is returned.
Update an existing lead's saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a lead's saved property. |
HTTP/1.1 200 OK If no POST data is supplied then a list of updatable fields with format information is returned.
Update an existing lead's saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a lead's saved property. |
HTTP/1.1 200 OK If no POST data is supplied then a list of updatable fields with format information is returned.
Update an existing lead's saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a lead's saved property. |
HTTP/1.1 200 OK If no POST data is supplied then a list of updatable fields with format information is returned.
Update an existing lead's saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a lead's saved property. |
HTTP/1.1 200 OK If no POST data is supplied then a list of updatable fields with format information is returned.
Update an existing lead's saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a lead's saved property. |
HTTP/1.1 200 OK If no POST data is supplied then a list of updatable fields with format information is returned.
Update an existing lead's saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a lead's saved property. |
HTTP/1.1 200 OK If no POST data is supplied then a list of updatable fields with format information is returned.
Update an existing lead's saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a lead's saved property. |
HTTP/1.1 200 OK If no POST data is supplied then a list of updatable fields with format information is returned.
Update an existing lead's saved property.
/leads/property
https://api.idxbroker.com/leads/property/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| propertyID | number |
The ID of a lead's saved property. |
HTTP/1.1 200 OK If no POST data is supplied then a list of updatable fields with format information is returned.
Create a new lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1
// Note: idxID and listingID are required.
// The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a saved property is successfully created the new property's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1
// Note: idxID and listingID are required.
// The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a saved property is successfully created the new property's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1
// Note: idxID and listingID are required.
// The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a saved property is successfully created the new property's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1
// Note: idxID and listingID are required.
// The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a saved property is successfully created the new property's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1
// Note: idxID and listingID are required.
// The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a saved property is successfully created the new property's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1
// Note: idxID and listingID are required.
// The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a saved property is successfully created the new property's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1
// Note: idxID and listingID are required.
// The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a saved property is successfully created the new property's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1
// Note: idxID and listingID are required.
// The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a saved property is successfully created the new property's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1
// Note: idxID and listingID are required.
// The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a saved property is successfully created the new property's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1
// Note: idxID and listingID are required.
// The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a saved property is successfully created the new property's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1
// Note: idxID and listingID are required.
// The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a saved property is successfully created the new property's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved property.
/leads/property
https://api.idxbroker.com/leads/property/1
// Note: idxID and listingID are required.
// The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'propertyName' => 'Test Property',
'property' => array('idxID' => 'a001', 'listingID' => '345678')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 OK "If a saved property is successfully created the new property's ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Remove a lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of the search to delete. |
HTTP/1.1 204 OK
Remove a lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of the search to delete. |
HTTP/1.1 204 OK
Remove a lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of the search to delete. |
HTTP/1.1 204 OK
Remove a lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of the search to delete. |
HTTP/1.1 204 OK
Remove a lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of the search to delete. |
HTTP/1.1 204 OK
Remove a lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of the search to delete. |
HTTP/1.1 204 OK
Remove a lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of the search to delete. |
HTTP/1.1 204 OK
Remove a lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of the search to delete. |
HTTP/1.1 204 OK
Remove a lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of the search to delete. |
HTTP/1.1 204 OK
Remove a lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of the search to delete. |
HTTP/1.1 204 OK
Remove a lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of the search to delete. |
HTTP/1.1 204 OK
Remove a lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of the search to delete. |
HTTP/1.1 204 OK
Get searches for a lead.
/leads/search
https://api.idxbroker.com/leads/search/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID optional | number |
The ID of a lead's search |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead search, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "an array with 2 keys. The key searchInformation that contains all existing saved search information. The key info will return messages about any returned saved search. Currently this info will tell you if any search's advanced fields are not valid in the IDX system."
Get searches for a lead.
/leads/search
https://api.idxbroker.com/leads/search/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID optional | number |
The ID of a lead's search |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead search, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "an array with 2 keys. The key searchInformation that contains all existing saved search information. The key info will return messages about any returned saved search. Currently this info will tell you if any search's advanced fields are not valid in the IDX system."
Get searches for a lead.
/leads/search
https://api.idxbroker.com/leads/search/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID optional | number |
The ID of a lead's search |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead search, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "an array with 2 keys. The key searchInformation that contains all existing saved search information. The key info will return messages about any returned saved search. Currently this info will tell you if any search's advanced fields are not valid in the IDX system."
Get searches for a lead.
/leads/search
https://api.idxbroker.com/leads/search/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID optional | number |
The ID of a lead's search |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead search, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "an array with 2 keys. The key searchInformation that contains all existing saved search information. The key info will return messages about any returned saved search. Currently this info will tell you if any search's advanced fields are not valid in the IDX system."
Get searches for a lead.
/leads/search
https://api.idxbroker.com/leads/search/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID optional | number |
The ID of a lead's search |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead search, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "an array with 2 keys. The key searchInformation that contains all existing saved search information. The key info will return messages about any returned saved search. Currently this info will tell you if any search's advanced fields are not valid in the IDX system."
Get searches for a lead.
/leads/search
https://api.idxbroker.com/leads/search/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID optional | number |
The ID of a lead's search |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead search, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "an array with 2 keys. The key searchInformation that contains all existing saved search information. The key info will return messages about any returned saved search. Currently this info will tell you if any search's advanced fields are not valid in the IDX system."
Get searches for a lead.
/leads/search
https://api.idxbroker.com/leads/search/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID optional | number |
The ID of a lead's search |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead search, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "an array with 2 keys. The key searchInformation that contains all existing saved search information. The key info will return messages about any returned saved search. Currently this info will tell you if any search's advanced fields are not valid in the IDX system."
Get searches for a lead.
/leads/search
https://api.idxbroker.com/leads/search/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID optional | number |
The ID of a lead's search |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead search, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "an array with 2 keys. The key searchInformation that contains all existing saved search information. The key info will return messages about any returned saved search. Currently this info will tell you if any search's advanced fields are not valid in the IDX system."
Get searches for a lead.
/leads/search
https://api.idxbroker.com/leads/search/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID optional | number |
The ID of a lead's search |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead search, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "an array with 2 keys. The key searchInformation that contains all existing saved search information. The key info will return messages about any returned saved search. Currently this info will tell you if any search's advanced fields are not valid in the IDX system."
Get searches for a lead.
/leads/search
https://api.idxbroker.com/leads/search/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID optional | number |
The ID of a lead's search |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead search, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "an array with 2 keys. The key searchInformation that contains all existing saved search information. The key info will return messages about any returned saved search. Currently this info will tell you if any search's advanced fields are not valid in the IDX system."
Get searches for a lead.
/leads/search
https://api.idxbroker.com/leads/search/1/1?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID optional | number |
The ID of a lead's search |
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead search, this will specify what is being used to return information. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "an array with 2 keys. The key searchInformation that contains all existing saved search information. The key info will return messages about any returned saved search. Currently this info will tell you if any search's advanced fields are not valid in the IDX system."
Get searches for a lead.
/leads/search
https://api.idxbroker.com/leads/search/1/1
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID optional | number |
The ID of a lead's search |
HTTP/1.1 200 OK "an array with 2 keys. The key searchInformation that contains all existing saved search information. The key info will return messages about any returned saved search. Currently this info will tell you if any search's advanced fields are not valid in the IDX system."
Update an existing lead's saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of a lead's saved search. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update an existing lead's saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of a lead's saved search. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update an existing lead's saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of a lead's saved search. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update an existing lead's saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of a lead's saved search. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update an existing lead's saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of a lead's saved search. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update an existing lead's saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of a lead's saved search. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update an existing lead's saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of a lead's saved search. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update an existing lead's saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of a lead's saved search. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update an existing lead's saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of a lead's saved search. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update an existing lead's saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of a lead's saved search. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update an existing lead's saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of a lead's saved search. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Update an existing lead's saved search.
/leads/search
https://api.idxbroker.com/leads/search/1/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as POST data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
| Field | Type | Description |
|---|---|---|
| searchID | number |
The ID of a lead's saved search. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Create a new lead saved search.
/leads/search
https://api.idxbroker.com/leads/search/1
// Note: The updatable fields need to be in a URL encoded, ampersand delineated query string format
// and need to be supplied as PUT data.
// PHP Example:
$data = array(
'searchName' => 'Test Search',
'search' => array('idxID' => 'a001', 'hp' => '200000')
);
$data = http_build_query($data); // encode and & delineate
| Field | Type | Description |
|---|---|---|
| leadID | number |
The ID of a lead. |
HTTP/1.1 200 "If a lead search is successfully created the new searches' ID will be returned. If no PUT data is supplied then a list of updatable fields with format information is returned."
Gives the date and time a particular MLS was last downloaded, processed and the last time images gathering was completed.
Note: dates/times given are UTC.
/mls/age
https://api.idxbroker.com/mls/age/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of timestamps for last downloaded, last processes and last images gathered."
Gives the date and time a particular MLS was last downloaded, processed and the last time images gathering was completed.
Note: dates/times given are UTC.
/mls/age
https://api.idxbroker.com/mls/age/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of timestamps for last downloaded, last processes and last images gathered."
Gives the date and time a particular MLS was last downloaded, processed and the last time images gathering was completed.
Note: dates/times given are UTC.
/mls/age
https://api.idxbroker.com/mls/age/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of timestamps for last downloaded, last processes and last images gathered."
Gives the date and time a particular MLS was last downloaded, processed and the last time images gathering was completed.
Note: dates/times given are UTC.
/mls/age
https://api.idxbroker.com/mls/age/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of timestamps for last downloaded, last processes and last images gathered."
Gives the date and time a particular MLS was last downloaded, processed and the last time images gathering was completed.
Note: dates/times given are UTC.
/mls/age
https://api.idxbroker.com/mls/age/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of timestamps for last downloaded, last processes and last images gathered."
Gives the date and time a particular MLS was last downloaded, processed and the last time images gathering was completed.
Note: dates/times given are UTC.
/mls/age
https://api.idxbroker.com/mls/age/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of timestamps for last downloaded, last processes and last images gathered."
Gives the date and time a particular MLS was last downloaded, processed and the last time images gathering was completed.
Note: dates/times given are UTC.
/mls/age
https://api.idxbroker.com/mls/age/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of timestamps for last downloaded, last processes and last images gathered."
Gives the date and time a particular MLS was last downloaded, processed and the last time images gathering was completed.
Note: dates/times given are UTC.
/mls/age
https://api.idxbroker.com/mls/age/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of timestamps for last downloaded, last processes and last images gathered."
Gives the date and time a particular MLS was last downloaded, processed and the last time images gathering was completed.
Note: dates/times given are UTC.
/mls/age
https://api.idxbroker.com/mls/age/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of timestamps for last downloaded, last processes and last images gathered."
Gives the date and time a particular MLS was last downloaded, processed and the last time images gathering was completed.
Note: dates/times given are UTC.
/mls/age
https://api.idxbroker.com/mls/age/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of timestamps for last downloaded, last processes and last images gathered."
Gives the date and time a particular MLS was last downloaded, processed and the last time images gathering was completed.
Note: dates/times given are UTC.
/mls/age
https://api.idxbroker.com/mls/age/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of timestamps for last downloaded, last processes and last images gathered."
Gives the date and time a particular MLS was last downloaded, processed and the last time images gathering was completed.
Note: dates/times given are UTC.
/mls/age
https://api.idxbroker.com/mls/age/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
HTTP/1.1 OK "An array of timestamps for last downloaded, last processes and last images gathered."
MLS approval instructions for a given mls.
/mls/approval-instructions
https://api.idxbroker.com/mls/approval-instructions/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
HTTP/1.1 OK "An array containing the title and content of the approval instructions."
This method provides all of the IDX IDs and names for all of the paperwork approved MLSs on the client's account.
Note: This method was previously camelcased as "approvedMLS" but was made lower case to fit the API naming convention. Calls to "approvedMLS" will be forwarded to "approvedmls" and "approvedMLS" is listed as deprecated in the method list.
/mls/approvedmls
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "A list of IDs and names for all MLSs approved for display on the client account."
This method provides all of the IDX IDs and names for all of the paperwork approved MLSs on the client's account.
Note: This method was previously camelcased as "approvedMLS" but was made lower case to fit the API naming convention. Calls to "approvedMLS" will be forwarded to "approvedmls" and "approvedMLS" is listed as deprecated in the method list.
/mls/approvedmls
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "A list of IDs and names for all MLSs approved for display on the client account."
This method provides all of the IDX IDs and names for all of the paperwork approved MLSs on the client's account.
Note: This method was previously camelcased as "approvedMLS" but was made lower case to fit the API naming convention. Calls to "approvedMLS" will be forwarded to "approvedmls" and "approvedMLS" is listed as deprecated in the method list.
/mls/approvedmls
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "A list of IDs and names for all MLSs approved for display on the client account."
This method provides all of the IDX IDs and names for all of the paperwork approved MLSs on the client's account.
Note: This method was previously camelcased as "approvedMLS" but was made lower case to fit the API naming convention. Calls to "approvedMLS" will be forwarded to "approvedmls" and "approvedMLS" is listed as deprecated in the method list.
/mls/approvedmls
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "A list of IDs and names for all MLSs approved for display on the client account."
This method provides all of the IDX IDs and names for all of the paperwork approved MLSs on the client's account.
Note: This method was previously camelcased as "approvedMLS" but was made lower case to fit the API naming convention. Calls to "approvedMLS" will be forwarded to "approvedmls" and "approvedMLS" is listed as deprecated in the method list.
/mls/approvedmls
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "A list of IDs and names for all MLSs approved for display on the client account."
This method provides all of the IDX IDs and names for all of the paperwork approved MLSs on the client's account.
Note: This method was previously camelcased as "approvedMLS" but was made lower case to fit the API naming convention. Calls to "approvedMLS" will be forwarded to "approvedmls" and "approvedMLS" is listed as deprecated in the method list.
/mls/approvedmls
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "A list of IDs and names for all MLSs approved for display on the client account."
This method provides all of the IDX IDs and names for all of the paperwork approved MLSs on the client's account.
Note: This method was previously camelcased as "approvedMLS" but was made lower case to fit the API naming convention. Calls to "approvedMLS" will be forwarded to "approvedmls" and "approvedMLS" is listed as deprecated in the method list.
/mls/approvedmls
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "A list of IDs and names for all MLSs approved for display on the client account."
This method provides all of the IDX IDs and names for all of the paperwork approved MLSs on the client's account.
Note: This method was previously camelcased as "approvedMLS" but was made lower case to fit the API naming convention. Calls to "approvedMLS" will be forwarded to "approvedmls" and "approvedMLS" is listed as deprecated in the method list.
/mls/approvedmls
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "A list of IDs and names for all MLSs approved for display on the client account."
This method provides all of the IDX IDs and names for all of the paperwork approved MLSs on the client's account.
Note: This method was previously camelcased as "approvedMLS" but was made lower case to fit the API naming convention. Calls to "approvedMLS" will be forwarded to "approvedmls" and "approvedMLS" is listed as deprecated in the method list.
/mls/approvedmls
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "A list of IDs and names for all MLSs approved for display on the client account."
This method provides all of the IDX IDs and names for all of the paperwork approved MLSs on the client's account.
Note: This method was previously camelcased as "approvedMLS" but was made lower case to fit the API naming convention. Calls to "approvedMLS" will be forwarded to "approvedmls" and "approvedMLS" is listed as deprecated in the method list.
/mls/approvedmls
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "A list of IDs and names for all MLSs approved for display on the client account."
This method provides all of the IDX IDs and names for all of the paperwork approved MLSs on the client's account.
Note: This method was previously camelcased as "approvedMLS" but was made lower case to fit the API naming convention. Calls to "approvedMLS" will be forwarded to "approvedmls" and "approvedMLS" is listed as deprecated in the method list.
/mls/approvedmls
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "A list of IDs and names for all MLSs approved for display on the client account."
This method provides all of the IDX IDs and names for all of the paperwork approved MLSs on the client's account.
Note: This method was previously camelcased as "approvedMLS" but was made lower case to fit the API naming convention. Calls to "approvedMLS" will be forwarded to "approvedmls" and "approvedMLS" is listed as deprecated in the method list.
/mls/approvedmls
HTTP/1.1 200 OK "A list of IDs and names for all MLSs approved for display on the client account."
All cities represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/cities
https://api.idxbroker.com/mls/cities/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available cities along with applicable city ID, property type, and state as well as a count of the number of occurrences for each value."
All cities represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/cities
https://api.idxbroker.com/mls/cities/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available cities along with applicable city ID, property type, and state as well as a count of the number of occurrences for each value."
All cities represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/cities
https://api.idxbroker.com/mls/cities/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available cities along with applicable city ID, property type, and state as well as a count of the number of occurrences for each value."
All cities represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/cities
https://api.idxbroker.com/mls/cities/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available cities along with applicable city ID, property type, and state as well as a count of the number of occurrences for each value."
All cities represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/cities
https://api.idxbroker.com/mls/cities/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available cities along with applicable city ID, property type, and state as well as a count of the number of occurrences for each value."
All cities represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/cities
https://api.idxbroker.com/mls/cities/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available cities along with applicable city ID, property type, and state as well as a count of the number of occurrences for each value."
All cities represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/cities
https://api.idxbroker.com/mls/cities/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available cities along with applicable city ID, property type, and state as well as a count of the number of occurrences for each value."
All cities represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/cities
https://api.idxbroker.com/mls/cities/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available cities along with applicable city ID, property type, and state as well as a count of the number of occurrences for each value."
All cities represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/cities
https://api.idxbroker.com/mls/cities/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available cities along with applicable city ID, property type, and state as well as a count of the number of occurrences for each value."
All cities represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/cities
https://api.idxbroker.com/mls/cities/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available cities along with applicable city ID, property type, and state as well as a count of the number of occurrences for each value."
All cities represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/cities
https://api.idxbroker.com/mls/cities/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available cities along with applicable city ID, property type, and state as well as a count of the number of occurrences for each value."
All cities represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/cities
https://api.idxbroker.com/mls/cities/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
HTTP/1.1 OK "Available cities along with applicable city ID, property type, and state as well as a count of the number of occurrences for each value."
All cities (limited to sold data) represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/cities/sold
https://api.idxbroker.com/mls/cities/sold/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available cities along with applicable city ID, property type, and state as well as a count of the number of occurrences for each value."
All cities (limited to sold data) represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/cities/sold
https://api.idxbroker.com/mls/cities/sold/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available cities along with applicable city ID, property type, and state as well as a count of the number of occurrences for each value."
All cities (limited to sold data) represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/cities/sold
https://api.idxbroker.com/mls/cities/sold/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available cities along with applicable city ID, property type, and state as well as a count of the number of occurrences for each value."
All counties represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/counties
https://api.idxbroker.com/mls/counties/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available counties along with applicable county ID, property type, and state as well as a count of the number of occurrences of each value."
All counties represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/counties
https://api.idxbroker.com/mls/counties/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available counties along with applicable county ID, property type, and state as well as a count of the number of occurrences of each value."
All counties represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/counties
https://api.idxbroker.com/mls/counties/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available counties along with applicable county ID, property type, and state as well as a count of the number of occurrences of each value."
All counties represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/counties
https://api.idxbroker.com/mls/counties/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available counties along with applicable county ID, property type, and state as well as a count of the number of occurrences of each value."
All counties represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/counties
https://api.idxbroker.com/mls/counties/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available counties along with applicable county ID, property type, and state as well as a count of the number of occurrences of each value."
All counties represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/counties
https://api.idxbroker.com/mls/counties/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available counties along with applicable county ID, property type, and state as well as a count of the number of occurrences of each value."
All counties represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/counties
https://api.idxbroker.com/mls/counties/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available counties along with applicable county ID, property type, and state as well as a count of the number of occurrences of each value."
All counties represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/counties
https://api.idxbroker.com/mls/counties/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available counties along with applicable county ID, property type, and state as well as a count of the number of occurrences of each value."
All counties represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/counties
https://api.idxbroker.com/mls/counties/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available counties along with applicable county ID, property type, and state as well as a count of the number of occurrences of each value."
All counties represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/counties
https://api.idxbroker.com/mls/counties/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available counties along with applicable county ID, property type, and state as well as a count of the number of occurrences of each value."
All counties represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/counties
https://api.idxbroker.com/mls/counties/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available counties along with applicable county ID, property type, and state as well as a count of the number of occurrences of each value."
All counties represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/counties
https://api.idxbroker.com/mls/counties/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
HTTP/1.1 OK "Available counties along with applicable county ID, property type, and state as well as a count of the number of occurrences of each value."
All counties (limited to sold data) represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/counties/sold
https://api.idxbroker.com/mls/counties/sold/a002?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available counties along with applicable county ID, property type, and state as well as a count of the number of occurrences of each value."
All counties (limited to sold data) represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/counties/sold
https://api.idxbroker.com/mls/counties/sold/a002?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available counties along with applicable county ID, property type, and state as well as a count of the number of occurrences of each value."
All counties (limited to sold data) represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/counties/sold
https://api.idxbroker.com/mls/counties/sold/a002?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available counties along with applicable county ID, property type, and state as well as a count of the number of occurrences of each value."
This is a simple, access anywhere, method for getting a list of all API components available.
/mls/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/mls/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/mls/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/mls/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/mls/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/mls/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/mls/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/mls/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/mls/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/mls/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/mls/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/mls/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/mls/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/mls/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/mls/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/mls/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/mls/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/mls/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/mls/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/mls/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/mls/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/mls/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/mls/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/mls/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
All postal codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/postalcodes
https://api.idxbroker.com/mls/postalcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available postalcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All postal codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/postalcodes
https://api.idxbroker.com/mls/postalcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available postalcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All postal codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/postalcodes
https://api.idxbroker.com/mls/postalcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available postalcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All postal codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/postalcodes
https://api.idxbroker.com/mls/postalcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available postalcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All postal codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/postalcodes
https://api.idxbroker.com/mls/postalcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available postalcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All postal codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/postalcodes
https://api.idxbroker.com/mls/postalcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available postalcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All postal codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/postalcodes
https://api.idxbroker.com/mls/postalcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available postalcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All postal codes (limited to sold data) represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/postalcodes/sold
https://api.idxbroker.com/mls/postalcodes/sold/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available postalcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All postal codes (limited to sold data) represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/postalcodes/sold
https://api.idxbroker.com/mls/postalcodes/sold/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available postalcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All postal codes (limited to sold data) represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/postalcodes/sold
https://api.idxbroker.com/mls/postalcodes/sold/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available postalcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
The sum total of properties listed in a given MLS as well as sums for each property type in the MLS.
/mls/prices
https://api.idxbroker.com/mls/prices/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "A multidimensional array with the total sum and the sum for each property type."
The sum total of properties listed in a given MLS as well as sums for each property type in the MLS.
/mls/prices
https://api.idxbroker.com/mls/prices/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "A multidimensional array with the total sum and the sum for each property type."
The sum total of properties listed in a given MLS as well as sums for each property type in the MLS.
/mls/prices
https://api.idxbroker.com/mls/prices/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "A multidimensional array with the total sum and the sum for each property type."
The sum total of properties listed in a given MLS as well as sums for each property type in the MLS.
/mls/prices
https://api.idxbroker.com/mls/prices/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "A multidimensional array with the total sum and the sum for each property type."
The sum total of properties listed in a given MLS as well as sums for each property type in the MLS.
/mls/prices
https://api.idxbroker.com/mls/prices/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "A multidimensional array with the total sum and the sum for each property type."
The sum total of properties listed in a given MLS as well as sums for each property type in the MLS.
/mls/prices
https://api.idxbroker.com/mls/prices/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "A multidimensional array with the total sum and the sum for each property type."
The sum total of properties listed in a given MLS as well as sums for each property type in the MLS.
/mls/prices
https://api.idxbroker.com/mls/prices/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "A multidimensional array with the total sum and the sum for each property type."
The sum total of properties listed in a given MLS as well as sums for each property type in the MLS.
/mls/prices
https://api.idxbroker.com/mls/prices/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "A multidimensional array with the total sum and the sum for each property type."
The sum total of properties listed in a given MLS as well as sums for each property type in the MLS.
/mls/prices
https://api.idxbroker.com/mls/prices/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "A multidimensional array with the total sum and the sum for each property type."
The sum total of properties listed in a given MLS as well as sums for each property type in the MLS.
/mls/prices
https://api.idxbroker.com/mls/prices/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "A multidimensional array with the total sum and the sum for each property type."
The sum total of properties listed in a given MLS as well as sums for each property type in the MLS.
/mls/prices
https://api.idxbroker.com/mls/prices/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "A multidimensional array with the total sum and the sum for each property type."
The sum total of properties listed in a given MLS as well as sums for each property type in the MLS.
/mls/prices
https://api.idxbroker.com/mls/prices/a001
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
HTTP/1.1 OK "A multidimensional array with the total sum and the sum for each property type."
The sum total of properties (limited to sold data) listed in a given MLS as well as sums for each property type in the MLS.
/mls/prices/sold
https://api.idxbroker.com/mls/prices/sold/a001
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "A multidimensional array with the total sum and the sum for each property type."
The sum total of properties (limited to sold data) listed in a given MLS as well as sums for each property type in the MLS.
/mls/prices/sold
https://api.idxbroker.com/mls/prices/sold/a001
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "A multidimensional array with the total sum and the sum for each property type."
The sum total of properties (limited to sold data) listed in a given MLS as well as sums for each property type in the MLS.
/mls/prices/sold
https://api.idxbroker.com/mls/prices/sold/a001
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "A multidimensional array with the total sum and the sum for each property type."
Gives a total number of listings available for a given city, county, or zipcode.
/mls/propertycount
https://api.idxbroker.com/mls/propertycount/a001?countType=city&countSpecifier=37536
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| countType | string |
Specify if you are looking for the count of a city, county, or zipcode. Allowed values:
|
| countSpecifier | number |
The numeric city ID, county ID, or zipcode for which you want to get a property count. |
HTTP/1.1 OK "An integer count of the number of properties."
Gives a total number of listings available for a given city, county, or zipcode.
/mls/propertycount
https://api.idxbroker.com/mls/propertycount/a001?countType=city&countSpecifier=37536
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| countType | string |
Specify if you are looking for the count of a city, county, or zipcode. Allowed values:
|
| countSpecifier | number |
The numeric city ID, county ID, or zipcode for which you want to get a property count. |
HTTP/1.1 OK "An integer count of the number of properties."
Gives a total number of listings available for a given city, county, or zipcode.
/mls/propertycount
https://api.idxbroker.com/mls/propertycount/a001?countType=city&countSpecifier=37536
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| countType | string |
Specify if you are looking for the count of a city, county, or zipcode. Allowed values:
|
| countSpecifier | number |
The numeric city ID, county ID, or zipcode for which you want to get a property count. |
HTTP/1.1 OK "An integer count of the number of properties."
Gives a total number of listings available for a given city, county, or zipcode.
/mls/propertycount
https://api.idxbroker.com/mls/propertycount/a001?countType=city&countSpecifier=37536
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| countType | string |
Specify if you are looking for the count of a city, county, or zipcode. Allowed values:
|
| countSpecifier | number |
The numeric city ID, county ID, or zipcode for which you want to get a property count. |
HTTP/1.1 OK "An integer count of the number of properties."
Gives a total number of listings available for a given city, county, or zipcode.
/mls/propertycount
https://api.idxbroker.com/mls/propertycount/a001?countType=city&countSpecifier=37536
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| countType | string |
Specify if you are looking for the count of a city, county, or zipcode. Allowed values:
|
| countSpecifier | number |
The numeric city ID, county ID, or zipcode for which you want to get a property count. |
HTTP/1.1 OK "An integer count of the number of properties."
Gives a total number of listings available for a given city, county, or zipcode.
/mls/propertycount
https://api.idxbroker.com/mls/propertycount/a001?countType=city&countSpecifier=37536
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| countType | string |
Specify if you are looking for the count of a city, county, or zipcode. Allowed values:
|
| countSpecifier | number |
The numeric city ID, county ID, or zipcode for which you want to get a property count. |
HTTP/1.1 OK "An integer count of the number of properties."
Gives a total number of listings available for a given city, county, or zipcode.
/mls/propertycount
https://api.idxbroker.com/mls/propertycount/a001?countType=city&countSpecifier=37536
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| countType | string |
Specify if you are looking for the count of a city, county, or zipcode. Allowed values:
|
| countSpecifier | number |
The numeric city ID, county ID, or zipcode for which you want to get a property count. |
HTTP/1.1 OK "An integer count of the number of properties."
Gives a total number of listings available for a given city, county, or zipcode.
/mls/propertycount
https://api.idxbroker.com/mls/propertycount/a001?countType=city&countSpecifier=37536
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| countType | string |
Specify if you are looking for the count of a city, county, or zipcode. Allowed values:
|
| countSpecifier | number |
The numeric city ID, county ID, or zipcode for which you want to get a property count. |
HTTP/1.1 OK "An integer count of the number of properties."
Gives a total number of listings available for a given city, county, or zipcode.
/mls/propertycount
https://api.idxbroker.com/mls/propertycount/a001?countType=city&countSpecifier=37536
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| countType | string |
Specify if you are looking for the count of a city, county, or zipcode. Allowed values:
|
| countSpecifier | number |
The numeric city ID, county ID, or zipcode for which you want to get a property count. |
HTTP/1.1 OK "An integer count of the number of properties."
Gives a total number of listings available for a given city, county, or zipcode.
/mls/propertycount
https://api.idxbroker.com/mls/propertycount/a001?countType=city&countSpecifier=37536
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| countType | string |
Specify if you are looking for the count of a city, county, or zipcode. Allowed values:
|
| countSpecifier | number |
The numeric city ID, county ID, or zipcode for which you want to get a property count. |
HTTP/1.1 OK "An integer count of the number of properties."
Gives a total number of listings available for a given city, county, or zipcode.
/mls/propertycount
https://api.idxbroker.com/mls/propertycount/a001?countType=city&countSpecifier=37536
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| countType | string |
Specify if you are looking for the count of a city, county, or zipcode. Allowed values:
|
| countSpecifier | number |
The numeric city ID, county ID, or zipcode for which you want to get a property count. |
HTTP/1.1 OK "An integer count of the number of properties."
Gives a total number of listings available for a given city, county, or zipcode.
/mls/propertycount
https://api.idxbroker.com/mls/propertycount/a001?countType=city&countSpecifier=37536
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| countType | string |
Specify if you are looking for the count of a city, county, or zipcode. Allowed values:
|
| countSpecifier | number |
The numeric city ID, county ID, or zipcode for which you want to get a property count. |
HTTP/1.1 OK "An integer count of the number of properties."
Gives a total number of listings available (limited to sold data) for a given city, county, or zipcode.
/mls/propertycount/sold
https://api.idxbroker.com/mls/propertycount/sold/a001?countType=city&countSpecifier=37536
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| countType | string |
Specify if you are looking for the count of a city, county, or zipcode. Allowed values:
|
| countSpecifier | number |
The numeric city ID, county ID, or zipcode for which you want to get a property count. |
HTTP/1.1 OK "An integer count of the number of properties."
Gives a total number of listings available (limited to sold data) for a given city, county, or zipcode.
/mls/propertycount/sold
https://api.idxbroker.com/mls/propertycount/sold/a001?countType=city&countSpecifier=37536
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| countType | string |
Specify if you are looking for the count of a city, county, or zipcode. Allowed values:
|
| countSpecifier | number |
The numeric city ID, county ID, or zipcode for which you want to get a property count. |
HTTP/1.1 OK "An integer count of the number of properties."
Gives a total number of listings available (limited to sold data) for a given city, county, or zipcode.
/mls/propertycount/sold
https://api.idxbroker.com/mls/propertycount/sold/a001?countType=city&countSpecifier=37536
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| countType | string |
Specify if you are looking for the count of a city, county, or zipcode. Allowed values:
|
| countSpecifier | number |
The numeric city ID, county ID, or zipcode for which you want to get a property count. |
HTTP/1.1 OK "An integer count of the number of properties."
Gives the property type information for all types that are available on a given MLS.
/mls/propertytypes
https://api.idxbroker.com/mls/propertytypes/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of property type information including MLS property type ID, MLS property type name, parent property type, and subtypes."
Gives the property type information for all types that are available on a given MLS.
/mls/propertytypes
https://api.idxbroker.com/mls/propertytypes/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of property type information including MLS property type ID, MLS property type name, parent property type, and subtypes."
Gives the property type information for all types that are available on a given MLS.
/mls/propertytypes
https://api.idxbroker.com/mls/propertytypes/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of property type information including MLS property type ID, MLS property type name, parent property type, and subtypes."
Gives the property type information for all types that are available on a given MLS.
/mls/propertytypes
https://api.idxbroker.com/mls/propertytypes/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of property type information including MLS property type ID, MLS property type name, parent property type, and subtypes."
Gives the property type information for all types that are available on a given MLS.
/mls/propertytypes
https://api.idxbroker.com/mls/propertytypes/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of property type information including MLS property type ID, MLS property type name, parent property type, and subtypes."
Gives the property type information for all types that are available on a given MLS.
/mls/propertytypes
https://api.idxbroker.com/mls/propertytypes/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of property type information including MLS property type ID, MLS property type name, parent property type, and subtypes."
Gives the property type information for all types that are available on a given MLS.
/mls/propertytypes
https://api.idxbroker.com/mls/propertytypes/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of property type information including MLS property type ID, MLS property type name, parent property type, and subtypes."
Gives the property type information for all types that are available on a given MLS.
/mls/propertytypes
https://api.idxbroker.com/mls/propertytypes/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of property type information including MLS property type ID, MLS property type name, parent property type, and subtypes."
Gives the property type information for all types that are available on a given MLS.
/mls/propertytypes
https://api.idxbroker.com/mls/propertytypes/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of property type information including MLS property type ID, MLS property type name, parent property type, and subtypes."
Gives the property type information for all types that are available on a given MLS.
/mls/propertytypes
https://api.idxbroker.com/mls/propertytypes/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of property type information including MLS property type ID, MLS property type name, parent property type, and subtypes."
Gives the property type information for all types that are available on a given MLS.
/mls/propertytypes
https://api.idxbroker.com/mls/propertytypes/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array of property type information including MLS property type ID, MLS property type name, parent property type, and subtypes."
Gives the property type information for all types that are available on a given MLS.
/mls/propertytypes
https://api.idxbroker.com/mls/propertytypes/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
HTTP/1.1 OK "An array of property type information including MLS property type ID, MLS property type name, parent property type, and subtypes."
All the fields in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfields
https://api.idxbroker.com/mls/searchfields/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | number |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing all MLS fields that are searchable according to MLS rules and IDX guidelines. Array contains the field's name (which is the field to be used as a key when performing a search), the display name (as should be displayed in a search form), and both the mlsPtID and parentPtID to which the field belongs."
All the fields in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfields
https://api.idxbroker.com/mls/searchfields/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | number |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing all MLS fields that are searchable according to MLS rules and IDX guidelines. Array contains the field's name (which is the field to be used as a key when performing a search), the display name (as should be displayed in a search form), and both the mlsPtID and parentPtID to which the field belongs."
All the fields in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfields
https://api.idxbroker.com/mls/searchfields/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | number |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing all MLS fields that are searchable according to MLS rules and IDX guidelines. Array contains the field's name (which is the field to be used as a key when performing a search), the display name (as should be displayed in a search form), and both the mlsPtID and parentPtID to which the field belongs."
All the fields in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfields
https://api.idxbroker.com/mls/searchfields/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | number |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing all MLS fields that are searchable according to MLS rules and IDX guidelines. Array contains the field's name (which is the field to be used as a key when performing a search), the display name (as should be displayed in a search form), and both the mlsPtID and parentPtID to which the field belongs."
All the fields in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfields
https://api.idxbroker.com/mls/searchfields/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | number |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing all MLS fields that are searchable according to MLS rules and IDX guidelines. Array contains the field's name (which is the field to be used as a key when performing a search), the display name (as should be displayed in a search form), and both the mlsPtID and parentPtID to which the field belongs."
All the fields in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfields
https://api.idxbroker.com/mls/searchfields/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | number |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing all MLS fields that are searchable according to MLS rules and IDX guidelines. Array contains the field's name (which is the field to be used as a key when performing a search), the display name (as should be displayed in a search form), and both the mlsPtID and parentPtID to which the field belongs."
All the fields in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfields
https://api.idxbroker.com/mls/searchfields/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | number |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing all MLS fields that are searchable according to MLS rules and IDX guidelines. Array contains the field's name (which is the field to be used as a key when performing a search), the display name (as should be displayed in a search form), and both the mlsPtID and parentPtID to which the field belongs."
All the fields in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfields
https://api.idxbroker.com/mls/searchfields/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | number |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing all MLS fields that are searchable according to MLS rules and IDX guidelines. Array contains the field's name (which is the field to be used as a key when performing a search), the display name (as should be displayed in a search form), and both the mlsPtID and parentPtID to which the field belongs."
All the fields in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfields
https://api.idxbroker.com/mls/searchfields/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | number |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing all MLS fields that are searchable according to MLS rules and IDX guidelines. Array contains the field's name (which is the field to be used as a key when performing a search), the display name (as should be displayed in a search form), and both the mlsPtID and parentPtID to which the field belongs."
All the fields in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfields
https://api.idxbroker.com/mls/searchfields/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | number |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing all MLS fields that are searchable according to MLS rules and IDX guidelines. Array contains the field's name (which is the field to be used as a key when performing a search), the display name (as should be displayed in a search form), and both the mlsPtID and parentPtID to which the field belongs."
All the fields in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfields
https://api.idxbroker.com/mls/searchfields/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | number |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing all MLS fields that are searchable according to MLS rules and IDX guidelines. Array contains the field's name (which is the field to be used as a key when performing a search), the display name (as should be displayed in a search form), and both the mlsPtID and parentPtID to which the field belongs."
All the fields in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfields
https://api.idxbroker.com/mls/searchfields/a001?filterField=mlsPtID&filterValue=1
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | number |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
HTTP/1.1 OK "An array containing all MLS fields that are searchable according to MLS rules and IDX guidelines. Array contains the field's name (which is the field to be used as a key when performing a search), the display name (as should be displayed in a search form), and both the mlsPtID and parentPtID to which the field belongs."
Field values in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfieldvalues
https://api.idxbroker.com/mls/searchfieldvalues/a001?mlsPtID=1&name=subdivision
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| mlsPtID | number |
The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. |
| name | string |
mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. |
HTTP/1.1 OK "An array containing all the values for the given mls field."
Field values in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfieldvalues
https://api.idxbroker.com/mls/searchfieldvalues/a001?mlsPtID=1&name=subdivision
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| mlsPtID | number |
The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. |
| name | string |
mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. |
HTTP/1.1 OK "An array containing all the values for the given mls field."
Field values in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfieldvalues
https://api.idxbroker.com/mls/searchfieldvalues/a001?mlsPtID=1&name=subdivision
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| mlsPtID | number |
The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. |
| name | string |
mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. |
HTTP/1.1 OK "An array containing all the values for the given mls field."
Field values in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfieldvalues
https://api.idxbroker.com/mls/searchfieldvalues/a001?mlsPtID=1&name=subdivision
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| mlsPtID | number |
The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. |
| name | string |
mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. |
HTTP/1.1 OK "An array containing all the values for the given mls field."
Field values in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfieldvalues
https://api.idxbroker.com/mls/searchfieldvalues/a001?mlsPtID=1&name=subdivision
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| mlsPtID | number |
The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. |
| name | string |
mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. |
HTTP/1.1 OK "An array containing all the values for the given mls field."
Field values in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfieldvalues
https://api.idxbroker.com/mls/searchfieldvalues/a001?mlsPtID=1&name=subdivision
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| mlsPtID | number |
The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. |
| name | string |
mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. |
HTTP/1.1 OK "An array containing all the values for the given mls field."
Field values in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfieldvalues
https://api.idxbroker.com/mls/searchfieldvalues/a001?mlsPtID=1&name=subdivision
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| mlsPtID | number |
The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. |
| name | string |
mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. |
HTTP/1.1 OK "An array containing all the values for the given mls field."
Field values in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfieldvalues
https://api.idxbroker.com/mls/searchfieldvalues/a001?mlsPtID=1&name=subdivision
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| mlsPtID | number |
The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. |
| name | string |
mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. |
HTTP/1.1 OK "An array containing all the values for the given mls field."
Field values in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfieldvalues
https://api.idxbroker.com/mls/searchfieldvalues/a001?mlsPtID=1&name=subdivision
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| mlsPtID | number |
The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. |
| name | string |
mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. |
HTTP/1.1 OK "An array containing all the values for the given mls field."
Field values in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfieldvalues
https://api.idxbroker.com/mls/searchfieldvalues/a001?mlsPtID=1&name=subdivision
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| mlsPtID | number |
The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. |
| name | string |
mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. |
HTTP/1.1 OK "An array containing all the values for the given mls field."
Field values in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfieldvalues
https://api.idxbroker.com/mls/searchfieldvalues/a001?mlsPtID=1&name=subdivision
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| mlsPtID | number |
The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. |
| name | string |
mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. |
HTTP/1.1 OK "An array containing all the values for the given mls field."
Field values in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfieldvalues
https://api.idxbroker.com/mls/searchfieldvalues/a001?mlsPtID=1&name=subdivision
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| mlsPtID | number |
The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. |
| name | string |
mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. |
HTTP/1.1 OK "An array containing all the values for the given mls field."
Field values (limited to sold data) in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfieldvalues/sold
https://api.idxbroker.com/mls/searchfieldvalues/sold/a001?mlsPtID=1&name=subdivision
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| mlsPtID | number |
The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. |
| name | string |
mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. |
HTTP/1.1 OK "An array containing all the values for the given mls field limited to sold data."
Field values (limited to sold data) in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfieldvalues/sold
https://api.idxbroker.com/mls/searchfieldvalues/sold/a001?mlsPtID=1&name=subdivision
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| mlsPtID | number |
The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. |
| name | string |
mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. |
HTTP/1.1 OK "An array containing all the values for the given mls field limited to sold data."
Field values (limited to sold data) in a given MLS that are currently allowed to be searched according to MLS guidelines.
/mls/searchfieldvalues/sold
https://api.idxbroker.com/mls/searchfieldvalues/sold/a001?mlsPtID=1&name=subdivision
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit the result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| mlsPtID | number |
The IDX assigned ID of the MLS property type(s). See the propertytypes method in this API/Component for a lookup of property type IDs. |
| name | string |
mls field name - the IDX assigned name of the MLS field name. See the searchfields for the list of searchable fields. |
HTTP/1.1 OK "An array containing all the values for the given mls field limited to sold data."
All zip codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/zipcodes
https://api.idxbroker.com/mls/zipcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available zipcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All zip codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/zipcodes
https://api.idxbroker.com/mls/zipcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available zipcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All zip codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/zipcodes
https://api.idxbroker.com/mls/zipcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available zipcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All zip codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/zipcodes
https://api.idxbroker.com/mls/zipcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available zipcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All zip codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/zipcodes
https://api.idxbroker.com/mls/zipcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available zipcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All zip codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/zipcodes
https://api.idxbroker.com/mls/zipcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available zipcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All zip codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/zipcodes
https://api.idxbroker.com/mls/zipcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available zipcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All zip codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/zipcodes
https://api.idxbroker.com/mls/zipcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available zipcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All zip codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/zipcodes
https://api.idxbroker.com/mls/zipcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available zipcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All zip codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/zipcodes
https://api.idxbroker.com/mls/zipcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available zipcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All zip codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/zipcodes
https://api.idxbroker.com/mls/zipcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available zipcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All zip codes represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/zipcodes
https://api.idxbroker.com/mls/zipcodes/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
HTTP/1.1 OK "Available zipcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All zip codes (limited to sold data) represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/zipcodes/sold
https://api.idxbroker.com/mls/zipcodes/sold/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available zipcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All zip codes (limited to sold data) represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/zipcodes/sold
https://api.idxbroker.com/mls/zipcodes/sold/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available zipcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
All zip codes (limited to sold data) represented in the current set of MLS data are available from this method. The output can be filtered using additional GET parameters.
/mls/zipcodes/sold
https://api.idxbroker.com/mls/zipcodes/sold/a001?filterField=stateAbrv&filterValue=OR
| Field | Type | Description |
|---|---|---|
| sold | string |
To limit result to sold data. |
| Field | Type | Description |
|---|---|---|
| idxID | string |
format: x000 |
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "Available zipcodes along with applicable property type and state as well as a count of the number of occurrences of each value."
Get a list of all agents for your clients.
/partners/aggregatedagents
https://api.idxbroker.com/aggregatedagents?rf[]=userID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All available agents."
Get a list of all agents for your clients.
/partners/aggregatedagents
https://api.idxbroker.com/aggregatedagents?rf[]=userID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All available agents."
Get a list of all agents for your clients.
/partners/aggregatedagents
https://api.idxbroker.com/aggregatedagents?rf[]=userID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All available agents."
Get a list of all agents for your clients.
/partners/aggregatedagents
https://api.idxbroker.com/aggregatedagents?rf[]=userID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All available agents."
Get a list of all agents for your clients.
/partners/aggregatedagents
https://api.idxbroker.com/aggregatedagents?rf[]=userID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All available agents."
Get a list of all agents for your clients.
/partners/aggregatedagents
https://api.idxbroker.com/aggregatedagents?rf[]=userID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All available agents."
Get a list of all agents for your clients.
/partners/aggregatedagents
https://api.idxbroker.com/aggregatedagents?rf[]=userID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "All available agents."
Get a list of all agents for your clients.
/partners/aggregatedagents
https://api.idxbroker.com/aggregatedagents?rf[]=userID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "All available agents."
Get a list of all agents for your clients.
/partners/aggregatedagents
https://api.idxbroker.com/aggregatedagents?rf[]=userID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "All available agents."
Get a list of all agents for your clients.
/partners/aggregatedagents
https://api.idxbroker.com/aggregatedagents?rf[]=userID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "All available agents."
Get a list of all agents for your clients.
/partners/aggregatedagents
https://api.idxbroker.com/aggregatedagents?rf[]=userID
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "All available agents."
Get a list of all agents for your clients.
/partners/aggregatedagents
HTTP/1.1 200 OK "All available agents."
Get a list of featured MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedfeatured
https://api.idxbroker.com/partners/aggregatedfeatured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded&rf[]=listingID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "list of featured MLS properties for each client."
Get a list of featured MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedfeatured
https://api.idxbroker.com/partners/aggregatedfeatured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded&rf[]=listingID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "list of featured MLS properties for each client."
Get a list of featured MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedfeatured
https://api.idxbroker.com/partners/aggregatedfeatured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded&rf[]=listingID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "list of featured MLS properties for each client."
Get a list of featured MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedfeatured
https://api.idxbroker.com/partners/aggregatedfeatured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded&rf[]=listingID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "list of featured MLS properties for each client."
Get a list of featured MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedfeatured
https://api.idxbroker.com/partners/aggregatedfeatured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded&rf[]=listingID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "list of featured MLS properties for each client."
Get a list of featured MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedfeatured
https://api.idxbroker.com/partners/aggregatedfeatured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded&rf[]=listingID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "list of featured MLS properties for each client."
Get a list of featured MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedfeatured
https://api.idxbroker.com/partners/aggregatedfeatured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded&rf[]=listingID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "list of featured MLS properties for each client."
Get a list of featured MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedfeatured
https://api.idxbroker.com/partners/aggregatedfeatured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded&rf[]=listingID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "list of featured MLS properties for each client."
Get a list of featured MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedfeatured
https://api.idxbroker.com/partners/aggregatedfeatured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded&rf[]=listingID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "list of featured MLS properties for each client."
Get a list of featured MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedfeatured
https://api.idxbroker.com/partners/aggregatedfeatured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded&rf[]=listingID&clientChunk=1&includeDisabledAccounts=true
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "list of featured MLS properties for each client."
Get a list of featured MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedfeatured
https://api.idxbroker.com/partners/aggregatedfeatured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "list of featured MLS properties for each client."
Get a list of featured MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedfeatured
https://api.idxbroker.com/partners/aggregatedfeatured?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| disclaimers optional | boolean |
Include MLS disclaimer/courtesy in the response. |
HTTP/1.1 200 OK "list of featured MLS properties for each client."
Get a list of all leads including their last 5 viewed listings and search results and total number of viewed listings. Note: Lead traffic information is limited to 180 days.
For bandwidth and memory considerations there is a limit of 5,000 on the number of leads that can be returned in any single request. Even if a full week of data is requested this limit will only be encountered if your clients have a combined average 30+ leads created, updated, or active per hour (as such it will be most common when requesting leads based on last property update date). If this limit is exceeded a 413 -Requested Entity Too Large error is returned. If encountered a smaller interval will need to be used.
/partners/aggregatedleads
https://api.idxbroker.com/partners/aggregatedleads?interval=24&startDatetime=2015-01-01+23:59:59&dateType=lastLoginDate
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, lead ID, first name, last name, email address, address, city, state/province, country, zipCode, phone number, ID of the agent assigned, email format (html or plain text), disabled status (y/n), allowed to log in to their account (y/n), will receive property updates (y/n), subscribe date, last edited, last login date, last property update date, last activity type, last activity date, last 5 viewed listings, last 5 search results and total number of viewed listings."
Get a list of all leads including their last 5 viewed listings and search results and total number of viewed listings. Note: Lead traffic information is limited to 180 days.
For bandwidth and memory considerations there is a limit of 5,000 on the number of leads that can be returned in any single request. Even if a full week of data is requested this limit will only be encountered if your clients have a combined average 30+ leads created, updated, or active per hour (as such it will be most common when requesting leads based on last property update date). If this limit is exceeded a 413 -Requested Entity Too Large error is returned. If encountered a smaller interval will need to be used.
/partners/aggregatedleads
https://api.idxbroker.com/partners/aggregatedleads?interval=24&startDatetime=2015-01-01+23:59:59&dateType=lastLoginDate
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, lead ID, first name, last name, email address, address, city, state/province, country, zipCode, phone number, ID of the agent assigned, email format (html or plain text), disabled status (y/n), allowed to log in to their account (y/n), will receive property updates (y/n), subscribe date, last edited, last login date, last property update date, last activity type, last activity date, last 5 viewed listings, last 5 search results and total number of viewed listings."
Get a list of all leads.
For bandwidth and memory considerations there is a limit of 5,000 on the number of leads that can be returned in any single request. Even if a full week of data is requested this limit will only be encountered if your clients have a combined average 30+ leads created, updated, or active per hour (as such it will be most common when requesting leads based on last property update date). If this limit is exceeded a 413 -Requested Entity Too Large error is returned. If encountered a smaller interval will need to be used.
/partners/aggregatedleads
https://api.idxbroker.com/partners/aggregatedleads?interval=24&startDatetime=2015-01-01+23:59:59&dateType=lastLoginDate
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, lead ID, first name, last name, email address, address, city, state/province, country, zipCode, phone number, ID of the agent assigned, email format (html or plain text), disabled status (y/n), allowed to log in to their account (y/n), will receive property updates (y/n), subscribe date, last edited, last login date, last property update date, last activity type, and last activity date."
Get a list of all leads.
For bandwidth and memory considerations there is a limit of 5,000 on the number of leads that can be returned in any single request. Even if a full week of data is requested this limit will only be encountered if your clients have a combined average 30+ leads created, updated, or active per hour (as such it will be most common when requesting leads based on last property update date). If this limit is exceeded a 413 -Requested Entity Too Large error is returned. If encountered a smaller interval will need to be used.
/partners/aggregatedleads
https://api.idxbroker.com/partners/aggregatedleads?interval=24&startDatetime=2015-01-01+23:59:59&dateType=lastLoginDate
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, lead ID, first name, last name, email address, address, city, state/province, country, zipCode, phone number, ID of the agent assigned, email format (html or plain text), disabled status (y/n), allowed to log in to their account (y/n), will receive property updates (y/n), subscribe date, last edited, last login date, last property update date, last activity type, and last activity date."
Get a list of all leads.
For bandwidth and memory considerations there is a limit of 5,000 on the number of leads that can be returned in any single request. Even if a full week of data is requested this limit will only be encountered if your clients have a combined average 30+ leads created, updated, or active per hour (as such it will be most common when requesting leads based on last property update date). If this limit is exceeded a 413 -Requested Entity Too Large error is returned. If encountered a smaller interval will need to be used.
/partners/aggregatedleads
https://api.idxbroker.com/partners/aggregatedleads?interval=24&startDatetime=2015-01-01+23:59:59&dateType=lastLoginDate
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, lead ID, first name, last name, email address, address, city, state/province, country, zipCode, phone number, ID of the agent assigned, email format (html or plain text), disabled status (y/n), allowed to log in to their account (y/n), will receive property updates (y/n), subscribe date, last edited, last login date, last property update date, last activity type, and last activity date."
Get a list of all leads.
For bandwidth and memory considerations there is a limit of 5,000 on the number of leads that can be returned in any single request. Even if a full week of data is requested this limit will only be encountered if your clients have a combined average 30+ leads created, updated, or active per hour (as such it will be most common when requesting leads based on last property update date). If this limit is exceeded a 413 -Requested Entity Too Large error is returned. If encountered a smaller interval will need to be used.
/partners/aggregatedleads
https://api.idxbroker.com/partners/aggregatedleads?interval=24&startDatetime=2015-01-01+23:59:59&dateType=lastLoginDate
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, lead ID, first name, last name, email address, address, city, state/province, country, zipCode, phone number, ID of the agent assigned, email format (html or plain text), disabled status (y/n), allowed to log in to their account (y/n), will receive property updates (y/n), subscribe date, last edited, last login date, last property update date, last activity type, and last activity date."
Get a list of all leads.
For bandwidth and memory considerations there is a limit of 5,000 on the number of leads that can be returned in any single request. Even if a full week of data is requested this limit will only be encountered if your clients have a combined average 30+ leads created, updated, or active per hour (as such it will be most common when requesting leads based on last property update date). If this limit is exceeded a 413 -Requested Entity Too Large error is returned. If encountered a smaller interval will need to be used.
/partners/aggregatedleads
https://api.idxbroker.com/partners/aggregatedleads?interval=24&startDatetime=2015-01-01+23:59:59&dateType=lastLoginDate
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, lead ID, first name, last name, email address, address, city, state/province, country, zipCode, phone number, ID of the agent assigned, email format (html or plain text), disabled status (y/n), allowed to log in to their account (y/n), will receive property updates (y/n), subscribe date, last edited, last login date, last property update date, last activity type, and last activity date."
Get a list of all leads.
For bandwidth and memory considerations there is a limit of 5,000 on the number of leads that can be returned in any single request. Even if a full week of data is requested this limit will only be encountered if your clients have a combined average 30+ leads created, updated, or active per hour (as such it will be most common when requesting leads based on last property update date). If this limit is exceeded a 413 -Requested Entity Too Large error is returned. If encountered a smaller interval will need to be used.
/partners/aggregatedleads
https://api.idxbroker.com/partners/aggregatedleads?interval=24&startDatetime=2015-01-01+23:59:59&dateType=lastLoginDate
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, lead ID, first name, last name, email address, address, city, state/province, country, zipCode, phone number, ID of the agent assigned, email format (html or plain text), disabled status (y/n), allowed to log in to their account (y/n), will receive property updates (y/n), subscribe date, last edited, last login date, last property update date, last activity type, and last activity date."
Get a list of all leads.
For bandwidth and memory considerations there is a limit of 5,000 on the number of leads that can be returned in any single request. Even if a full week of data is requested this limit will only be encountered if your clients have a combined average 30+ leads created, updated, or active per hour (as such it will be most common when requesting leads based on last property update date). If this limit is exceeded a 413 -Requested Entity Too Large error is returned. If encountered a smaller interval will need to be used.
/partners/aggregatedleads
https://api.idxbroker.com/partners/aggregatedleads?interval=24&startDatetime=2015-01-01+23:59:59&dateType=lastLoginDate
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, lead ID, first name, last name, email address, address, city, state/province, country, zipCode, phone number, ID of the agent assigned, email format (html or plain text), disabled status (y/n), allowed to log in to their account (y/n), will receive property updates (y/n), subscribe date, last edited, last login date, last property update date, last activity type, and last activity date."
Get a list of all leads.
For bandwidth and memory considerations there is a limit of 5,000 on the number of leads that can be returned in any single request. Even if a full week of data is requested this limit will only be encountered if your clients have a combined average 30+ leads created, updated, or active per hour (as such it will be most common when requesting leads based on last property update date). If this limit is exceeded a 413 -Requested Entity Too Large error is returned. If encountered a smaller interval will need to be used.
/partners/aggregatedleads
https://api.idxbroker.com/partners/aggregatedleads?interval=24&startDatetime=2015-01-01+23:59:59&dateType=lastLoginDate
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, lead ID, first name, last name, email address, address, city, state/province, country, zipCode, phone number, ID of the agent assigned, email format (html or plain text), disabled status (y/n), allowed to log in to their account (y/n), will receive property updates (y/n), subscribe date, last edited, last login date, last property update date, last activity type, and last activity date."
Get a list of all leads.
For bandwidth and memory considerations there is a limit of 5,000 on the number of leads that can be returned in any single request. Even if a full week of data is requested this limit will only be encountered if your clients have a combined average 30+ leads created, updated, or active per hour (as such it will be most common when requesting leads based on last property update date). If this limit is exceeded a 413 -Requested Entity Too Large error is returned. If encountered a smaller interval will need to be used.
/partners/aggregatedleads
https://api.idxbroker.com/partners/aggregatedleads?interval=24&startDatetime=2015-01-01+23:59:59&dateType=lastLoginDate
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The applicable client account ID, lead ID, first name, last name, email address, address, city, state/province, country, zipCode, phone number, ID of the agent assigned, email format (html or plain text), disabled status (y/n), allowed to log in to their account (y/n), will receive property updates (y/n), subscribe date, last edited, last login date, last property update date, last activity type, and last activity date."
Get a list of all leads.
For bandwidth and memory considerations there is a limit of 5,000 on the number of leads that can be returned in any single request. Even if a full week of data is requested this limit will only be encountered if your clients have a combined average 30+ leads created, updated, or active per hour (as such it will be most common when requesting leads based on last property update date). If this limit is exceeded a 413 -Requested Entity Too Large error is returned. If encountered a smaller interval will need to be used.
/partners/aggregatedleads
https://api.idxbroker.com/partners/aggregatedleads?interval=24&startDatetime=2015-01-01+23:59:59&dateType=lastLoginDate
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified subscribeDate will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
HTTP/1.1 200 OK "The applicable client account ID, lead ID, first name, last name, email address, address, city, state/province, country, zipCode, phone number, ID of the agent assigned, email format (html or plain text), disabled status (y/n), allowed to log in to their account (y/n), will receive property updates (y/n), subscribe date, last edited, last login date, last property update date, last activity type, and last activity date."
Get a list of all leads traffic history.
Note: For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedleadtraffic
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get a list of all leads traffic history.
Note: For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedleadtraffic
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get a list of all leads traffic history.
Note: For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedleadtraffic
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get a list of all leads traffic history.
Note: For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedleadtraffic
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get a list of all leads traffic history.
Note: For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedleadtraffic
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get a list of all leads traffic history.
Note: For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedleadtraffic
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get a list of all leads traffic history.
Note: For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedleadtraffic
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get a list of all leads traffic history.
Note: For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedleadtraffic
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get a list of all leads traffic history.
Note: For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedleadtraffic
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get a list of all leads traffic history.
Note: For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedleadtraffic
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get a list of all leads traffic history.
Note: For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedleadtraffic
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
Get a list of all leads traffic history.
Note: For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedleadtraffic
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
HTTP/1.1 200 OK "The applicable client account ID, date, lead ID, IP , page, and referrer."
This method gives the status for all MLS listings (not supplemental) broken down by client account ID. This includes sold/pending listings with an unknown status which are not usually returned by sold/pending api methods. This is helpful if you need to know when previously gathered featured properties have left the market.
/partners/aggregatedlistingstatus
https://api.idxbroker.com/partners/aggregatedlistingstatus?filterField=status&filterValue=active
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField. Allowed values:
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "MLS listings along with their statuses."
This method gives the status for all MLS listings (not supplemental) broken down by client account ID. This includes sold/pending listings with an unknown status which are not usually returned by sold/pending api methods. This is helpful if you need to know when previously gathered featured properties have left the market.
/partners/aggregatedlistingstatus
https://api.idxbroker.com/partners/aggregatedlistingstatus?filterField=status&filterValue=active
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField. Allowed values:
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "MLS listings along with their statuses."
This method gives the status for all MLS listings (not supplemental) broken down by client account ID. This includes sold/pending listings with an unknown status which are not usually returned by sold/pending api methods. This is helpful if you need to know when previously gathered featured properties have left the market.
/partners/aggregatedlistingstatus
https://api.idxbroker.com/partners/aggregatedlistingstatus?filterField=status&filterValue=active
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField. Allowed values:
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "MLS listings along with their statuses."
This method gives the status for all MLS listings (not supplemental) broken down by client account ID. This includes sold/pending listings with an unknown status which are not usually returned by sold/pending api methods. This is helpful if you need to know when previously gathered featured properties have left the market.
/partners/aggregatedlistingstatus
https://api.idxbroker.com/partners/aggregatedlistingstatus?filterField=status&filterValue=active
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField. Allowed values:
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "MLS listings along with their statuses."
This method gives the status for all MLS listings (not supplemental) broken down by client account ID. This includes sold/pending listings with an unknown status which are not usually returned by sold/pending api methods. This is helpful if you need to know when previously gathered featured properties have left the market.
/partners/aggregatedlistingstatus
https://api.idxbroker.com/partners/aggregatedlistingstatus?filterField=status&filterValue=active
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField. Allowed values:
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "MLS listings along with their statuses."
This method gives the status for all MLS listings (not supplemental) broken down by client account ID. This includes sold/pending listings with an unknown status which are not usually returned by sold/pending api methods. This is helpful if you need to know when previously gathered featured properties have left the market.
/partners/aggregatedlistingstatus
https://api.idxbroker.com/partners/aggregatedlistingstatus?filterField=status&filterValue=active
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField. Allowed values:
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "MLS listings along with their statuses."
This method gives the status for all MLS listings (not supplemental) broken down by client account ID. This includes sold/pending listings with an unknown status which are not usually returned by sold/pending api methods. This is helpful if you need to know when previously gathered featured properties have left the market.
/partners/aggregatedlistingstatus
https://api.idxbroker.com/partners/aggregatedlistingstatus?filterField=status&filterValue=active
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField. Allowed values:
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "MLS listings along with their statuses."
This method gives the status for all MLS listings (not supplemental) broken down by client account ID. This includes sold/pending listings with an unknown status which are not usually returned by sold/pending api methods. This is helpful if you need to know when previously gathered featured properties have left the market.
/partners/aggregatedlistingstatus
https://api.idxbroker.com/partners/aggregatedlistingstatus?filterField=status&filterValue=active
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField. Allowed values:
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "MLS listings along with their statuses."
This method gives the status for all MLS listings (not supplemental) broken down by client account ID. This includes sold/pending listings with an unknown status which are not usually returned by sold/pending api methods. This is helpful if you need to know when previously gathered featured properties have left the market.
/partners/aggregatedlistingstatus
https://api.idxbroker.com/partners/aggregatedlistingstatus?filterField=status&filterValue=active
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField. Allowed values:
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "MLS listings along with their statuses."
This method give the status for all MLS listings (not supplemental) broken down by client account ID. This includes sold/pending listings with an unknown status which are not usually returned by sold/pending api methods. This is helpful if you need to know when previously gathered featured properties have left the market.
/partners/aggregatedlistingstatus
https://api.idxbroker.com/partners/aggregatedlistingstatus?filterField=status&filterValue=active
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField. Allowed values:
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "MLS listings along with their statuses."
This method gives the status for all MLS listings (not supplemental) broken down by client account ID. This includes sold/pending listings with an unknown status which are not usually returned by sold/pending api methods. This is helpful if you need to know when previously gathered featured properties have left the market.
/partners/aggregatedlistingstatus
https://api.idxbroker.com/partners/aggregatedlistingstatus?filterField=status&filterValue=active
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField. Allowed values:
|
HTTP/1.1 200 OK "MLS listings along with their statuses."
This method gives the status for all MLS listings (not supplemental) broken down by client account ID. This includes sold/pending listings with an unknown status which are not usually returned by sold/pending api methods. This is helpful if you need to know when previously gathered featured properties have left the market.
/partners/aggregatedlistingstatus
https://api.idxbroker.com/partners/aggregatedlistingstatus?filterField=status&filterValue=active
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField. Allowed values:
|
HTTP/1.1 200 OK "MLS listings along with their statuses."
Get a list of all lead saved properties.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedproperties
https://api.idxbroker.com/partners/aggregatedproperties?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved properties.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedproperties
https://api.idxbroker.com/partners/aggregatedproperties?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved properties.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedproperties
https://api.idxbroker.com/partners/aggregatedproperties?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved properties.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedproperties
https://api.idxbroker.com/partners/aggregatedproperties?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved properties.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedproperties
https://api.idxbroker.com/partners/aggregatedproperties?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved properties.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedproperties
https://api.idxbroker.com/partners/aggregatedproperties?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved properties.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedproperties
https://api.idxbroker.com/partners/aggregatedproperties?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved properties.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedproperties
https://api.idxbroker.com/partners/aggregatedproperties?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved properties.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedproperties
https://api.idxbroker.com/partners/aggregatedproperties?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved properties.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedproperties
https://api.idxbroker.com/partners/aggregatedproperties?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved properties.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedproperties
https://api.idxbroker.com/partners/aggregatedproperties?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved properties.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedproperties
https://api.idxbroker.com/partners/aggregatedproperties?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved searches.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedsearches
https://api.idxbroker.com/partners/aggregatedsearches?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved searches.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedsearches
https://api.idxbroker.com/partners/aggregatedsearches?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved searches.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedsearches
https://api.idxbroker.com/partners/aggregatedsearches?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved searches.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedsearches
https://api.idxbroker.com/partners/aggregatedsearches?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved searches.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedsearches
https://api.idxbroker.com/partners/aggregatedsearches?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved searches.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedsearches
https://api.idxbroker.com/partners/aggregatedsearches?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved searches.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedsearches
https://api.idxbroker.com/partners/aggregatedsearches?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved searches.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedsearches
https://api.idxbroker.com/partners/aggregatedsearches?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved searches.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedsearches
https://api.idxbroker.com/partners/aggregatedsearches?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved searches.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedsearches
https://api.idxbroker.com/partners/aggregatedsearches?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved searches.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedsearches
https://api.idxbroker.com/partners/aggregatedsearches?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of all lead saved searches.
For bandwidth and memory considerations there is a limit of 5,000 on the number of searches that can be returned in any single request.
/partners/aggregatedsearches
https://api.idxbroker.com/partners/aggregatedsearches?interval=24&startDatetime=2015-01-01+23:59:59&dateType=created
| Field | Type | Description |
|---|---|---|
| dateType optional | datetime |
There are several dates associated with a lead, this will specify is being used to return information. If no value is specified created will be used. Allowed values:
|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
HTTP/1.1 200 OK "search ID, the applicable client account ID, lead ID, page ID, search name, search parameters, lead will receive property updates (y/n), created date, last edited date."
Get a list of sold/pending MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
We are planning to add the ability to query by the date the property left the market and, for sold listings, the date it was sold in a future update.
/partners/aggregatedsoldpending
https://api.idxbroker.com/partners/aggregatedsoldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "list of soldpending properties for each client."
Get a list of sold/pending MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
We are planning to add the ability to query by the date the property left the market and, for sold listings, the date it was sold in a future update.
/partners/aggregatedsoldpending
https://api.idxbroker.com/partners/aggregatedsoldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "list of soldpending properties for each client."
Get a list of sold/pending MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
We are planning to add the ability to query by the date the property left the market and, for sold listings, the date it was sold in a future update.
/partners/aggregatedsoldpending
https://api.idxbroker.com/partners/aggregatedsoldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "list of soldpending properties for each client."
Get a list of sold/pending MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
We are planning to add the ability to query by the date the property left the market and, for sold listings, the date it was sold in a future update.
/partners/aggregatedsoldpending
https://api.idxbroker.com/partners/aggregatedsoldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "list of soldpending properties for each client."
Get a list of sold/pending MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
We are planning to add the ability to query by the date the property left the market and, for sold listings, the date it was sold in a future update.
/partners/aggregatedsoldpending
https://api.idxbroker.com/partners/aggregatedsoldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "list of soldpending properties for each client."
Get a list of sold/pending MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
We are planning to add the ability to query by the date the property left the market and, for sold listings, the date it was sold in a future update.
/partners/aggregatedsoldpending
https://api.idxbroker.com/partners/aggregatedsoldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "list of soldpending properties for each client."
Get a list of sold/pending MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
We are planning to add the ability to query by the date the property left the market and, for sold listings, the date it was sold in a future update.
/partners/aggregatedsoldpending
https://api.idxbroker.com/partners/aggregatedsoldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "list of soldpending properties for each client."
Get a list of sold/pending MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
We are planning to add the ability to query by the date the property left the market and, for sold listings, the date it was sold in a future update.
/partners/aggregatedsoldpending
https://api.idxbroker.com/partners/aggregatedsoldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "list of soldpending properties for each client."
Get a list of sold/pending MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
We are planning to add the ability to query by the date the property left the market and, for sold listings, the date it was sold in a future update.
/partners/aggregatedsoldpending
https://api.idxbroker.com/partners/aggregatedsoldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "list of soldpending properties for each client."
Get a list of sold/pending MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
We are planning to add the ability to query by the date the property left the market and, for sold listings, the date it was sold in a future update.
/partners/aggregatedsoldpending
https://api.idxbroker.com/partners/aggregatedsoldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "list of soldpending properties for each client."
Get a list of sold/pending MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
We are planning to add the ability to query by the date the property left the market and, for sold listings, the date it was sold in a future update.
/partners/aggregatedsoldpending
https://api.idxbroker.com/partners/aggregatedsoldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "list of soldpending properties for each client."
Get a list of sold/pending MLS properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
We are planning to add the ability to query by the date the property left the market and, for sold listings, the date it was sold in a future update.
/partners/aggregatedsoldpending
https://api.idxbroker.com/partners/aggregatedsoldpending?interval=24&startDatetime=2015-01-01+23:59:59&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
HTTP/1.1 200 OK "list of soldpending properties for each client."
Get a list of supplemental (non-MLS) properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedsupplemental
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59&&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "list of supplemental (non-MLS) properties for each client."
Get a list of supplemental (non-MLS) properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedsupplemental
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59&&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "list of supplemental (non-MLS) properties for each client."
Get a list of supplemental (non-MLS) properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedsupplemental
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59&&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "list of supplemental (non-MLS) properties for each client."
Get a list of supplemental (non-MLS) properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedsupplemental
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59&&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "list of supplemental (non-MLS) properties for each client."
Get a list of supplemental (non-MLS) properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedsupplemental
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59&&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "list of supplemental (non-MLS) properties for each client."
Get a list of supplemental (non-MLS) properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedsupplemental
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59&&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "list of supplemental (non-MLS) properties for each client."
Get a list of supplemental (non-MLS) properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedsupplemental
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59&&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
| offset optional | number |
Items to skip from the beginning.
|
| limit optional | number |
Number of items to return.
|
HTTP/1.1 200 OK "list of supplemental (non-MLS) properties for each client."
Get a list of supplemental (non-MLS) properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedsupplemental
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59&&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "list of supplemental (non-MLS) properties for each client."
Get a list of supplemental (non-MLS) properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedsupplemental
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59&&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "list of supplemental (non-MLS) properties for each client."
Get a list of supplemental (non-MLS) properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedsupplemental
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59&&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
| clientChunk optional | number |
Limit the results data to 400 clients. Example: clientChunk=1 returns data for the first 400 clients and clientChunk=2 returns the data for the next 400 clients. |
| includeDisabledAccounts optional | boolean |
By default, disabled accounts are excluded from the results data. Use this parameter to include disabled accounts. |
HTTP/1.1 200 OK "list of supplemental (non-MLS) properties for each client."
Get a list of supplemental (non-MLS) properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedsupplemental
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59&&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 200 OK "list of supplemental (non-MLS) properties for each client."
Get a list of supplemental (non-MLS) properties.
Output fields may or may not be populated depending on how the information was entered into the IDX system.
/partners/aggregatedsupplemental
https://api.idxbroker.com/partners/aggregatedleadtraffic?interval=24&startDatetime=2015-01-01+23:59:59&&dateType=dateAdded
| Field | Type | Description |
|---|---|---|
| interval optional | number |
The number of hours worth of data to return.
|
| startDatetime optional | datetime |
The date and time to from which the interval counts back.
|
| dateType optional | datetime |
There are several dates associated with a property, this will specify what is being used to return information. If no value is specified dateAdded will be used. Allowed values:
|
HTTP/1.1 200 OK "list of supplemental (non-MLS) properties for each client."
Get the default api version.
/partners/apiversion
HTTP/1.1 200 OK "The default api version."
Get the default api version.
/partners/apiversion
HTTP/1.1 200 OK "The default api version."
Get the default api version.
/partners/apiversion
HTTP/1.1 200 OK "The default api version."
Get the default api version.
/partners/apiversion
HTTP/1.1 200 OK "The default api version."
Get the default api version.
/partners/apiversion
HTTP/1.1 200 OK "The default api version."
Get the default api version.
/partners/apiversion
HTTP/1.1 200 OK "The default api version."
Get the default api version.
/partners/apiversion
HTTP/1.1 200 OK "The default api version."
Get the default api version.
/partners/apiversion
HTTP/1.1 200 OK "The default api version."
Get the latest api version.
/partners/apiversion
HTTP/1.1 200 OK "The latest api version."
Get the latest api version.
/partners/apiversion
HTTP/1.1 200 OK "The latest api version."
List of available MLSs with their fees.
/partners/availablemls
HTTP/1.1 200 OK "List of available MLSs with their fees."
List of available MLSs with their fees.
/partners/availablemls
HTTP/1.1 200 OK "List of available MLSs with their fees."
List of available MLSs with their fees.
/partners/availablemls
HTTP/1.1 200 OK "List of available MLSs with their fees."
List of available MLSs with their fees.
/partners/availablemls
HTTP/1.1 200 OK "List of available MLSs with their fees."
List of available MLSs with their fees.
/partners/availablemls
HTTP/1.1 200 OK "List of available MLSs with their fees."
A list of clients available to a given partner. The list of clients can be filtered by GET values.
/partners/clients
https://api.idxbroker.com/partners/clients?filterField=accountStatus&filterValue=enabled
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "The account ID, company name, display name, account status, multiuser addon, current API key, and approved MLSs of each client or clients matching the filter values."
A list of clients available to a given partner. The list of clients can be filtered by GET values.
/partners/clients
https://api.idxbroker.com/partners/clients?filterField=accountStatus&filterValue=enabled
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "The account ID, company name, display name, account status, multiuser addon, current API key, and approved MLSs of each client or clients matching the filter values."
A list of clients available to a given partner. The list of clients can be filtered by GET values.
/partners/clients
https://api.idxbroker.com/partners/clients?filterField=accountStatus&filterValue=enabled
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "The account ID, company name, display name, account status, multiuser addon, current API key, and approved MLSs of each client or clients matching the filter values."
A list of clients available to a given partner. The list of clients can be filtered by GET values.
/partners/clients
https://api.idxbroker.com/partners/clients?filterField=accountStatus&filterValue=enabled
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "The account ID, company name, display name, account status, multiuser addon, current API key, and approved MLSs of each client or clients matching the filter values."
A list of clients available to a given partner. The list of clients can be filtered by GET values.
/partners/clients
https://api.idxbroker.com/partners/clients?filterField=accountStatus&filterValue=enabled
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "The account ID, company name, display name, account status, and current API key of each client or clients matching the filter values."
A list of clients available to a given partner. The list of clients can be filtered by GET values.
/partners/clients
https://api.idxbroker.com/partners/clients?filterField=accountStatus&filterValue=enabled
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "The account ID, company name, display name, account status, and current API key of each client or clients matching the filter values."
A list of clients available to a given partner. The list of clients can be filtered by GET values.
/partners/clients
https://api.idxbroker.com/partners/clients?filterField=accountStatus&filterValue=enabled
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "The account ID, company name, display name, account status, and current API key of each client or clients matching the filter values."
A list of clients available to a given partner. The list of clients can be filtered by GET values.
/partners/clients
https://api.idxbroker.com/partners/clients?filterField=accountStatus&filterValue=enabled
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "The account ID, company name, display name, account status, and current API key of each client or clients matching the filter values."
A list of clients available to a given partner. The list of clients can be filtered by GET values.
/partners/clients
https://api.idxbroker.com/partners/clients?filterField=accountStatus&filterValue=enabled
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "The account ID, company name, display name, account status, and current API key of each client or clients matching the filter values."
A list of clients available to a given partner. The list of clients can be filtered by GET values.
/partners/clients
https://api.idxbroker.com/partners/clients?filterField=accountStatus&filterValue=enabled
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "The account ID, company name, display name, account status, and current API key of each client or clients matching the filter values."
A list of clients available to a given partner. The list of clients can be filtered by GET values.
/partners/clients
https://api.idxbroker.com/partners/clients?filterField=accountStatus&filterValue=enabled
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "The account ID, company name, display name, account status, and current API key of each client or clients matching the filter values."
A list of clients available to a given partner. The list of clients can be filtered by GET values.
/partners/clients
https://api.idxbroker.com/partners/clients?filterField=accountStatus&filterValue=enabled
| Field | Type | Description |
|---|---|---|
| filterField optional | string |
The field to use when filtering output. Allowed values:
|
| filterValue optional | string |
The value by which to filter. Conditional on use of filterField |
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "The account ID, company name, display name, account status, and current API key of each client or clients matching the filter values."
This is a simple, access anywhere, method for getting a list of all API components available.
/partners/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/partners/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/partners/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/partners/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/partners/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/partners/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/partners/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/partners/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/partners/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/partners/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/partners/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
This is a simple, access anywhere, method for getting a list of all API components available.
/partners/listcomponents
HTTP/1.1 200 OK "All available APIs/Components."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/partners/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/partners/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/partners/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/partners/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/partners/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/partners/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/partners/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/partners/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/partners/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/partners/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/partners/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
A simple method for listing all available methods in the current API component. This method will also list which request methods (GET, PUT, POST, or DELETE) are supported by each method in addition to each method status.
/partners/listmethods
HTTP/1.1 200 OK "Basic information about all available methods in this API."
Get IDX account and agent/office add-on pricing.
/partners/pricing
HTTP/1.1 200 OK "IDX account and agent/office add-on pricing."
Get IDX account and agent/office add-on pricing.
/partners/pricing
HTTP/1.1 200 OK "IDX account and agent/office add-on pricing."
Get IDX account and agent/office add-on pricing.
/partners/pricing
HTTP/1.1 200 OK "IDX account and agent/office add-on pricing."
Gives the names and IDs of all available property types. This method differs from the property type lookup method in the client API component in that it can look up property types for any active Platinum MLS, not just those for which the client is a member.
Note: The IDX property types are those used for multiple MLS searches and are equivalent to the property types used in the original IDX product. The data returned is structured as:
/partners/propertytypes
https://api.idxbroker.com/partners/propertytypes/a001
| Field | Type | Description |
|---|---|---|
| idxID optional | string |
The IDX ID of the MLS from which you need property type information. If no IDX ID is specified then only the IDX property types (parentPtID) will be returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing the IDX property types and, if an IDX ID has been provided, the MLS's property types and their IDs."
Gives the names and IDs of all available property types. This method differs from the property type lookup method in the client API component in that it can look up property types for any active Platinum MLS, not just those for which the client is a member.
Note: The IDX property types are those used for multiple MLS searches and are equivalent to the property types used in the original IDX product. The data returned is structured as:
/partners/propertytypes
https://api.idxbroker.com/partners/propertytypes/a001
| Field | Type | Description |
|---|---|---|
| idxID optional | string |
The IDX ID of the MLS from which you need property type information. If no IDX ID is specified then only the IDX property types (parentPtID) will be returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing the IDX property types and, if an IDX ID has been provided, the MLS's property types and their IDs."
Gives the names and IDs of all available property types. This method differs from the property type lookup method in the client API component in that it can look up property types for any active Platinum MLS, not just those for which the client is a member.
Note: The IDX property types are those used for multiple MLS searches and are equivalent to the property types used in the original IDX product. The data returned is structured as:
/partners/propertytypes
https://api.idxbroker.com/partners/propertytypes/a001
| Field | Type | Description |
|---|---|---|
| idxID optional | string |
The IDX ID of the MLS from which you need property type information. If no IDX ID is specified then only the IDX property types (parentPtID) will be returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing the IDX property types and, if an IDX ID has been provided, the MLS's property types and their IDs."
Gives the names and IDs of all available property types. This method differs from the property type lookup method in the client API component in that it can look up property types for any active Platinum MLS, not just those for which the client is a member.
Note: The IDX property types are those used for multiple MLS searches and are equivalent to the property types used in the original IDX product. The data returned is structured as:
/partners/propertytypes
https://api.idxbroker.com/partners/propertytypes/a001
| Field | Type | Description |
|---|---|---|
| idxID optional | string |
The IDX ID of the MLS from which you need property type information. If no IDX ID is specified then only the IDX property types (parentPtID) will be returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing the IDX property types and, if an IDX ID has been provided, the MLS's property types and their IDs."
Gives the names and IDs of all available property types. This method differs from the property type lookup method in the client API component in that it can look up property types for any active Platinum MLS, not just those for which the client is a member.
Note: The IDX property types are those used for multiple MLS searches and are equivalent to the property types used in the original IDX product. The data returned is structured as:
/partners/propertytypes
https://api.idxbroker.com/partners/propertytypes/a001
| Field | Type | Description |
|---|---|---|
| idxID optional | string |
The IDX ID of the MLS from which you need property type information. If no IDX ID is specified then only the IDX property types (parentPtID) will be returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing the IDX property types and, if an IDX ID has been provided, the MLS's property types and their IDs."
Gives the names and IDs of all available property types. This method differs from the property type lookup method in the client API component in that it can look up property types for any active Platinum MLS, not just those for which the client is a member.
Note: The IDX property types are those used for multiple MLS searches and are equivalent to the property types used in the original IDX product. The data returned is structured as:
/partners/propertytypes
https://api.idxbroker.com/partners/propertytypes/a001
| Field | Type | Description |
|---|---|---|
| idxID optional | string |
The IDX ID of the MLS from which you need property type information. If no IDX ID is specified then only the IDX property types (parentPtID) will be returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing the IDX property types and, if an IDX ID has been provided, the MLS's property types and their IDs."
Gives the names and IDs of all available property types. This method differs from the property type lookup method in the client API component in that it can look up property types for any active Platinum MLS, not just those for which the client is a member.
Note: The IDX property types are those used for multiple MLS searches and are equivalent to the property types used in the original IDX product. The data returned is structured as:
/partners/propertytypes
https://api.idxbroker.com/partners/propertytypes/a001
| Field | Type | Description |
|---|---|---|
| idxID optional | string |
The IDX ID of the MLS from which you need property type information. If no IDX ID is specified then only the IDX property types (parentPtID) will be returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing the IDX property types and, if an IDX ID has been provided, the MLS's property types and their IDs."
Gives the names and IDs of all available property types. This method differs from the property type lookup method in the client API component in that it can look up property types for any active Platinum MLS, not just those for which the client is a member.
Note: The IDX property types are those used for multiple MLS searches and are equivalent to the property types used in the original IDX product. The data returned is structured as:
/partners/propertytypes
https://api.idxbroker.com/partners/propertytypes/a001
| Field | Type | Description |
|---|---|---|
| idxID optional | string |
The IDX ID of the MLS from which you need property type information. If no IDX ID is specified then only the IDX property types (parentPtID) will be returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing the IDX property types and, if an IDX ID has been provided, the MLS's property types and their IDs."
Gives the names and IDs of all available property types. This method differs from the property type lookup method in the client API component in that it can look up property types for any active Platinum MLS, not just those for which the client is a member.
Note: The IDX property types are those used for multiple MLS searches and are equivalent to the property types used in the original IDX product. The data returned is structured as:
/partners/propertytypes
https://api.idxbroker.com/partners/propertytypes/a001
| Field | Type | Description |
|---|---|---|
| idxID optional | string |
The IDX ID of the MLS from which you need property type information. If no IDX ID is specified then only the IDX property types (parentPtID) will be returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing the IDX property types and, if an IDX ID has been provided, the MLS's property types and their IDs."
Gives the names and IDs of all available property types. This method differs from the property type lookup method in the client API component in that it can look up property types for any active Platinum MLS, not just those for which the client is a member.
Note: The IDX property types are those used for multiple MLS searches and are equivalent to the property types used in the original IDX product. The data returned is structured as:
/partners/propertytypes
https://api.idxbroker.com/partners/propertytypes/a001
| Field | Type | Description |
|---|---|---|
| idxID optional | string |
The IDX ID of the MLS from which you need property type information. If no IDX ID is specified then only the IDX property types (parentPtID) will be returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing the IDX property types and, if an IDX ID has been provided, the MLS's property types and their IDs."
Gives the names and IDs of all available property types. This method differs from the property type lookup method in the client API component in that it can look up property types for any active Platinum MLS, not just those for which the client is a member.
Note: The IDX property types are those used for multiple MLS searches and are equivalent to the property types used in the original IDX product. The data returned is structured as:
/partners/propertytypes
https://api.idxbroker.com/partners/propertytypes/a001
| Field | Type | Description |
|---|---|---|
| idxID optional | string |
The IDX ID of the MLS from which you need property type information. If no IDX ID is specified then only the IDX property types (parentPtID) will be returned. |
| Field | Type | Description |
|---|---|---|
| rf optional | array |
Array of fields to return in the output.
|
HTTP/1.1 OK "An array containing the IDX property types and, if an IDX ID has been provided, the MLS's property types and their IDs."
Gives the names and IDs of all available property types. This method differs from the property type lookup method in the client API component in that it can look up property types for any active Platinum MLS, not just those for which the client is a member.
Note: The IDX property types are those used for multiple MLS searches and are equivalent to the property types used in the original IDX product. The data returned is structured as:
/partners/propertytypes
https://api.idxbroker.com/partners/propertytypes/a001
| Field | Type | Description |
|---|---|---|
| idxID optional | string |
The IDX ID of the MLS from which you need property type information. If no IDX ID is specified then only the IDX property types (parentPtID) will be returned. |
HTTP/1.1 OK "An array containing the IDX property types and, if an IDX ID has been provided, the MLS's property types and their IDs."
Create IDX subscriber. Once the client account is created, the API key associated with the new signup will be activated.
/partners/subscriber
$url = 'https://api.idxbroker.com/partners/subscriber';
// Note: To get list of required or optional fields, simply make a request with nothing in the body.
// Make sure all required fields are passed in the request body.
// Example:
$data = [
'product' => 'lite',
'firstName' => 'Test',
'lastName' => 'Test',
'companyName' => 'Test Company',
'address' => '1000 E Test street',
'city' => 'Eugene',
'state' => 'OR', // Use XX for international.
'zipcode' => 97402,
'primaryPhone' => '5555555555',
'email' => 'test@gmail.com',
'website' => 'http://example.com',
'mlsIDList' => 'a001,a002',
'agreeToTermsOfService' => 'yes',
'customDomain' => 'search.example.com',
'useCustomDomain' => 'y',
];
$data = http_build_query($data); // Encode and & delineate.
HTTP/1.1 200 OK "An API key assigned to the specific client signup, which will be used and activated once the client account is created."
HTTP/1.1 400 "Missing required or invalid fields."
HTTP/1.1 400 "Website address is not valid."
HTTP/1.1 409 "Subscriber already exists."
HTTP/1.1 409 "Custom Domain already exists."
HTTP/1.1 500 "Failure to create client signup."
Create IDX subscriber.
/partners/subscriber
$url = 'https://api.idxbroker.com/partners/subscriber';
// Note: To get list of required or optional fields, simply make a request with nothing in the body.
// Make sure all required fields are passed in the request body.
// Example:
$data = [
'product' => 'lite',
'firstName' => 'Test',
'lastName' => 'Test',
'companyName' => 'Test Company',
'address' => '1000 E Test street',
'city' => 'Eugene',
'state' => 'OR', // Use XX for international.
'zipcode' => 97402,
'primaryPhone' => '5555555555',
'email' => 'test@gmail.com',
'website' => 'http://example.com',
'mlsIDList' => 'a001,a002',
'agreeToTermsOfService' => 'yes'
];
$data = http_build_query($data); // Encode and & delineate.
HTTP/1.1 204 OK
Create IDX subscriber.
/partners/subscriber
$url = 'https://api.idxbroker.com/partners/subscriber';
// Note: To get list of required or optional fields, simply make a request with nothing in the body.
// Make sure all required fields are passed in the request body.
// Example:
$data = [
'product' => 'lite',
'firstName' => 'Test',
'lastName' => 'Test',
'companyName' => 'Test Company',
'address' => '1000 E Test street',
'city' => 'Eugene',
'state' => 'OR', // Use XX for international.
'zipcode' => 97402,
'primaryPhone' => '5555555555',
'email' => 'test@gmail.com',
'website' => 'http://example.com',
'mlsIDList' => 'a001,a002',
'agreeToTermsOfService' => 'yes'
];
$data = http_build_query($data); // Encode and & delineate.
HTTP/1.1 204 OK